API Key

Overview

API Key authentication method is dedicated to customers building their own integrations, apps or connectors meant to be used only by them (not productised) or integrations that won’t have any user facing interface. Reason for this is that API Key doesn’t require SmartRecruiters User to Authenticate access to its data, the API Key is the authentication in itself and acts as a specific user.

The API key is a 32-characters string that is auto-generated for each SmartRecruiters admin user account and represents that user.

Obtain the API Key

You can obtain the API key in the API / Integrations section in your SmartRecruiters admin account.
If you want to use our APIs to integrate with other systems, we recommend to have a dedicated Admin user and API key for each integration.

Pass the API key

You can pass the API key for authentication using X-SmartToken – HTTP request header.

Example:

curl -i -H "X-SmartToken: abc123" -X GET https://api.smartrecruiters.com/jobs