Rezome API reference

A versioned REST API for jobs, candidates, applications, interviews, offers and webhooks. Authenticate with an organisation-scoped API key passed as a bearer token. Keys are created in Settings, carry per-resource scopes, and can be restricted by IP.

45 endpoints across 11 resource groups. The machine-readable specification is at /api/v1/openapi.json. A Model Context Protocol server is also available at /api/mcp for AI agent clients.

Mobile Auth

  • POST/api/mobile/auth/login— Mobile sign-in
  • POST/api/mobile/auth/refresh— Refresh mobile session
  • GET/api/mobile/me— Get mobile user and organizations

Authentication

  • GET/api/v1/me— Verify a key

Jobs

  • GET/api/v1/jobs— List jobs
  • POST/api/v1/jobs— Create a job
  • GET/api/v1/jobs/{id}— Get a job
  • PATCH/api/v1/jobs/{id}— Update a job
  • DELETE/api/v1/jobs/{id}— Delete a job
  • POST/api/v1/jobs/{id}/archive— Archive (or restore) a job

Candidates

  • GET/api/v1/candidates— List candidates
  • POST/api/v1/candidates— Create (or link) a candidate
  • GET/api/v1/candidates/{id}— Get a candidate
  • PATCH/api/v1/candidates/{id}— Update a source-owned candidate
  • DELETE/api/v1/candidates/{id}— Remove from talent pool
  • POST/api/v1/candidates/ingest— Ingest a CV in one call
  • GET/api/v1/candidates/ingest/{ingest_id}— Get the status of an async ingest

Documents

  • GET/api/v1/candidates/{id}/documents— List documents
  • POST/api/v1/candidates/{id}/documents— Register a document and get a signed upload URL
  • GET/api/v1/candidates/{id}/documents/{doc_id}— Get a signed download URL for a document

Tags

  • GET/api/v1/candidates/{id}/tags— List a candidate's tags
  • POST/api/v1/candidates/{id}/tags— Add a tag
  • DELETE/api/v1/candidates/{id}/tags/{tag_id}— Remove a tag
  • GET/api/v1/tags— List distinct tags in use

Applications

  • GET/api/v1/applications— List applications
  • POST/api/v1/applications— Create an application
  • GET/api/v1/applications/{id}— Get an application
  • PATCH/api/v1/applications/{id}— Update an application (move stage, score, notes)
  • GET/api/v1/applications/{id}/notes— List notes on the candidate behind this application
  • POST/api/v1/applications/{id}/notes— Add a note

Interviews

  • GET/api/v1/interviews— List interviews
  • POST/api/v1/interviews— Schedule an interview
  • GET/api/v1/interviews/{id}— Get an interview
  • PATCH/api/v1/interviews/{id}— Update an interview
  • POST/api/v1/interviews/{id}/cancel— Cancel an interview

Offers

  • GET/api/v1/offers— List offers
  • POST/api/v1/offers— Create an offer
  • GET/api/v1/offers/{id}— Get an offer
  • PATCH/api/v1/offers/{id}— Update an offer

Members

  • GET/api/v1/members— List org members

Webhooks

  • GET/api/v1/webhooks— List webhook endpoints
  • POST/api/v1/webhooks— Create a webhook endpoint
  • GET/api/v1/webhooks/{id}— Get a webhook endpoint
  • DELETE/api/v1/webhooks/{id}— Delete a webhook endpoint
  • POST/api/v1/webhooks/{id}/test— Send a test ping event