Skip to content

Create Access Token

POST
/v1/auth/token

Exchange your client credentials for a time-limited access token. Use the returned token in the X-Auth-Token header on all subsequent API requests.

Request Body required

object
client_id
required

Your partner client ID, provided by RecruitiFi during onboarding.

string
client_secret
required

Your partner client secret, provided by RecruitiFi during onboarding.

string
Example
{
"client_id": "your-client-id",
"client_secret": "your-client-secret"
}

Responses

200

Access token created successfully.

object
access_token
required

The access token to include in the X-Auth-Token header on subsequent requests.

string
token_type
required

The type of token issued. Always “bearer”.

string
Allowed values: bearer
expires_in
required

Token lifetime in seconds. After expiry, request a new token.

integer
Example
{
"access_token": "eyJhbGciOiJIUzI1NiIs...",
"token_type": "bearer",
"expires_in": 3600
}

401

Invalid credentials — client_id or client_secret is incorrect.

object
error
required

Machine-readable error code.

string
message
required

Human-readable error description.

string
Example
{
"error": "unauthorized",
"message": "Invalid client_id or client_secret."
}