SmartRecruiters ATS

Authentication Type

• Choose API Key if you have permission to create one in your SmartRecruiters ATS account, otherwise select Client Credentials.
• One major difference is that an API Key has all scopes by default, whereas with Client Credentials you can restrict the accessible scope.

API Key

1. Log in to SmartRecruiters and open the Credential Manager from your account's administration settings.
2. Click New Credential and select API Key from the menu.
3. Enter a descriptive credential name and description so admins can identify its purpose later.
4. Click Generate. Your 32-character API key will appear in a pop-up — this is the only time it will be shown.
5. Copy the API key immediately and store it securely, as it cannot be retrieved again once the pop-up is closed.
6. Use this API key during integration setup in Knit.

For more details, refer to the SmartRecruiters API Key documentation.

Client Credentials

1. Log in to SmartRecruiters and open the Credential Manager from your account's administration settings.
2. Click New Credential and select OAuth Client ID from the menu.
3. Enter a credential name and description, then select the OAuth scopes you want to grant, along with the required System Role and an optional Access Group. Following the principle of least privilege, select only the scopes needed for your integration. Access Candidates, Access Jobs these should be selected to perform a successful integration.
4. Click Generate to receive a Client ID and Client Secret pair, shown only once in a pop-up.
5. Copy and securely store both values, as they cannot be retrieved again once the pop-up is closed.
6. Use the Client ID and Client Secret during integration setup in Knit.

For more details, refer to the SmartRecruiters OAuth Client Credentials documentation.