Quickstart

Make your first API request in under 5 minutes.

Create an API key

Go to Integrations → API keys and click New API key. Choose a descriptive name and the scopes that match your needs. Copy the key shown: it is only visible once.

Store your key in a secrets manager (for example: environment variables, Vault, AWS Secrets Manager). Never commit it to your source code.

First request

Replace <your-api-key> with the key you copied:

bash

Expected response:

response.json

Explore the endpoints

See the API Reference in the sidebar to explore all available endpoints: Interviews, Candidates, Jobs, Processes, Tests, and Reports.

If you get a 401 Unauthorized error, check that your key is active and that the required scope has been granted to it.

Frequently asked questions

Yes, an API key is active as soon as it is created. There is no propagation delay: you can use it right away.

This is not recommended. Create one key per environment (dev, staging, prod) to make rotation easier and limit the risk if a key is compromised.

The key is only visible once, at creation time. If you lose it, revoke it from Integrations → API keys and create a new one.