Alfa API

Changelog

Additions within /v1, such as new fields, events and endpoints, are not breaking changes, so your integration should ignore fields it does not know. A breaking change ships as /v2 with at least 6 months' notice; the deprecations page lists what is due for removal.

Alfa API v1: API keys, ATS jobs, linked jobs, candidates, webhooks, applicant intake and platform keys

  • API keys, generated in Settings › Developers, with live and test environments, scopes, rotation and expiry.
  • ATS jobs: create and update your jobs so recruiters can link Alfa jobs to them.
  • Linked jobs and candidates, with resumes and polling by update time.
  • Webhooks: candidate.screened, candidate.status_changed and webhook.test, signed, retried for 24 hours, with a delivery log and redelivery.
  • Applicant intake for platform keys.
  • Platform keys, for ATS platforms that serve many client companies.

Start with the Alfa API overview or the API reference.