Reference

Health and key check

Two free endpoints: a public health check for uptime monitors, and a key check that confirms an API key and shows its account and credit balance.

Check API health

GET/api/v1/health

Check that the Job Extract, Match, Skills and Rank service is up. No API key needed.

Authentication: No API key
Billing: Free
Client timeout: Client timeout ≥ 10 s

Response

200The service is up.

statusstring
healthy whenever the service answers.
"healthy""unhealthy"
servicestring
"HireLayer API"
timestampstring (date-time)
Server time, ISO 8601 UTC.

Errors

502
Upstream API unavailable
The service is down or did not answer within 60 seconds.
Retry with backoff

Behavior

Scope: Covers the service behind /api/v1. It does not check HireLayer CV Extract (/api/v3/parser), and it does not validate API keys.

Request

curl https://hirelayer.co/api/v1/health

import requests

response = requests.get(
    "https://hirelayer.co/api/v1/health",
    timeout=10,
)
response.raise_for_status()

data = response.json()
print(data["status"])

const response = await fetch('https://hirelayer.co/api/v1/health', {
  signal: AbortSignal.timeout(10_000),
})

if (!response.ok) {
  throw new Error(`HireLayer ${response.status}: ${await response.text()}`)
}

const data = await response.json()
console.log(data.status)

Response

{
  "status": "healthy",
  "service": "HireLayer API",
  "timestamp": "2026-10-01T09:30:12.417Z"
}

{
  "error": "Upstream API unavailable"
}

Check an API key

GET/api/v1/me

Check that an API key is valid and see the account and credit balance it belongs to. Integrations use it to test a connection.

Authentication: X-API-Key header
Billing: Free
Client timeout: Client timeout ≥ 10 s

Response

200The key is valid.

authenticatedboolean
true
accountobject
›Show 2 child fieldsHide child fields
- emailstring | null
  Email of the account that owns the key.
- planstring
  Current plan.
  "free""starter""scale""pay_as_you_go""enterprise"
creditsobject
›Show 2 child fieldsHide child fields
- availableinteger | null
  Credits left: monthly credits plus purchased credits. null on an unlimited plan or when the balance could not be read.
- unlimitedboolean
  true on plans without a credit limit.

Errors

401
Missing API Key
The X-API-Key header is absent. Authorization: Bearer is not accepted.
Do not retry
401
Invalid API Key
The key is malformed, unknown or revoked. Rotating a key revokes the previous one immediately.
Do not retry
500
Internal server error
Unexpected gateway failure.
Retry with backoff

Behavior

Billing: Free and not counted as API usage, so a connection test in n8n, Zapier, Make or Power Automate never spends a credit.

Request

curl https://hirelayer.co/api/v1/me \
  -H "X-API-Key: $HIRELAYER_API_KEY"

import os

import requests

response = requests.get(
    "https://hirelayer.co/api/v1/me",
    headers={"X-API-Key": os.environ["HIRELAYER_API_KEY"]},
    timeout=10,
)
response.raise_for_status()

data = response.json()
print(data["account"]["email"])

const response = await fetch('https://hirelayer.co/api/v1/me', {
  headers: {
    'X-API-Key': process.env.HIRELAYER_API_KEY!,
  },
  signal: AbortSignal.timeout(10_000),
})

if (!response.ok) {
  throw new Error(`HireLayer ${response.status}: ${await response.text()}`)
}

const data = await response.json()
console.log(data.account.email)

Response

{
  "authenticated": true,
  "account": {
    "email": "[email protected]",
    "plan": "starter"
  },
  "credits": {
    "available": 742,
    "unlimited": false
  }
}

{
  "error": "Missing API Key"
}