API reference

The REST API, grouped by resource.

companies

GET/v1/companiesList companies in your tenant.POST/v1/companiesCreate or upsert a company.GET/v1/companies/{id}Fetch a company with intelligence.PATCH/v1/companies/{id}Update company core fields.POST/v1/companies/{id}/enrichQueue re-enrichment.

jobs

GET/v1/jobsList jobs.POST/v1/jobsCreate a job (status defaults to draft).GET/v1/jobs/{id}Fetch a job with intelligence.PATCH/v1/jobs/{id}Update job fields.POST/v1/jobs/{id}/publishPublish a draft job.POST/v1/jobs/{id}/closeClose a job.

candidates

GET/v1/candidatesList candidates in your tenant.POST/v1/candidatesCreate a candidate.GET/v1/candidates/{id}Fetch a candidate with intelligence.PATCH/v1/candidates/{id}Update candidate fields.POST/v1/candidates/{id}/enrichQueue re-parsing and re-enrichment.GET/v1/candidates/{id}/similarGet candidates similar to this one.

applications

GET/v1/applicationsList applications, filterable by job or candidate.POST/v1/applicationsSubmit a candidate to a job.POST/v1/applications/{id}/advanceMove an application to the next stage.

interviews

POST/v1/interviewsSchedule an interview.PATCH/v1/interviews/{id}Update or complete an interview.

placements

POST/v1/placementsRecord a placement (hire).

matches

POST/v1/matchesCompute scored matches for a job.POST/v1/matches/scoreCompute a single (candidate, job) score.

uploads

POST/v1/uploadsCreate a presigned upload URL.GET/v1/uploads/{id}Get upload metadata.

events

GET/v1/eventsList recent platform events.POST/v1/webhooksRegister a webhook subscription.GET/v1/webhooksList webhook subscriptions.DELETE/v1/webhooks/{id}Delete a webhook subscription.

usage

GET/v1/usageGet AI usage and quota information.