API — early access

Interviews, wherever you hire

An integration-friendly API for ATS and HR systems. Endpoints below are planned contracts, available to early-access customers as they ship.

Request API access Developer resources

Planned endpoints

POST/api/v1/jobsCreate a job

POST/api/v1/candidatesAdd a candidate

POST/api/v1/interviewsCreate an interview

POST/api/v1/interviews/{id}/invitationsSend an invitation

GET/api/v1/interviews/{id}Interview status

GET/api/v1/interviews/{id}/reportEvaluation report

POST/api/v1/webhooks/endpointsRegister a webhook

Example request

Placeholder values only. Keep API keys on your server — never embed them in browser JavaScript.

curl -X POST https://api.interviewiq.example/api/v1/interviews \
  -H "Authorization: Bearer $INTERVIEWIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "job_id": "job_123",
    "candidate_id": "cand_456",
    "scheduled_at": "2026-11-01T10:00:00Z"
  }'

Platform principles

Authentication

Bearer API keys scoped to your organization, stored hashed.

Interview lifecycle

scheduled → in progress → completed → reported.

Webhooks

Signed events when interviews complete or reports are ready.

Errors

Consistent JSON errors with codes and request IDs.

Rate limits

Per-key limits with clear response headers.

Versioning

Versioned paths (/v1) with deprecation notice.