Skip to main content
The InterviewFlowAI API connects your ATS or internal tools to InterviewFlowAI. Call it from your server with an API key.

Interviewers

Create an Interviewer when a role opens, and update its settings later.

Candidates

Invite Candidates, fetch their results, and sync stages, notes and custom fields.
To get notified when something happens, such as a completed interview, see Webhooks.

Base URL

Authentication

Send your API key in the X-API-KEY header:
A key works on its own Company only. Only Owners can create keys. See API keys. Your plan must include API access. Without it, every request returns 403.

Rate limits

Limits are per API key. Over the limit, requests get 429. Wait, then retry.

Requests and responses

Send JSON bodies with Content-Type: application/json. Successful responses wrap the result in data:
Errors return the HTTP status in code, and a readable message:

Status codes

Endpoints