Sign inBook a demo

Contents

Alfa API

Overview
Quickstart
Authentication
Platform keys
Applicant intake
Webhooks
Changelog

Guides

Overview
Errors
Pagination
Idempotency
Preconditions
Deprecations

Alfa API reference

ATS jobs

PUTCreate or update an ATS job
GETList ATS jobs

Jobs

GETGet a linked Alfa job
GETList linked Alfa jobs

Candidates

GETGet a candidate
GETGet a link to a candidate's resume
GETList candidates

Applicant intake

POSTSend an applicant for screening

Webhooks

POSTSend an event again
GETList webhook deliveries
GETGet your webhook endpoint
PUTSet your webhook endpoint
DELETERemove your webhook endpoint
POSTRotate the signing secret
POSTSend a test event

Webhook events

POSTA candidate was screened
POSTA candidate's status changed
POSTA test event

Web app API reference

Agent

GETGet a staged action's receipt
PUTSave the recruiter's edits to a staged inbox reply
POSTRun a confirmed staged action
GETGet the receipt of a draft job's latest staged action
GETList the exceptions that need the recruiter today
GETFind applicants and sourced people by name or email
GETGet a candidate's headline profile, evaluation, notes and applications
GETGet a candidate's resume text and a link to the file
POSTClassify a draft message for the composer badge
GETGet the evidence matrix for one to five applicants of a job
GETGet candidates' applications to a job, including removed ones
GETGet a job's lifecycle, pipeline counts and sourcing channels
GETList the organisation's example requests for the composer
POSTRead a document attached to the conversation
POSTRetire a conversation so its context starts fresh
POSTStop a conversation's turn in flight
GETSuggest follow-up prompts for a conversation's latest reply
GETGet a context's open conversation with its messages and tool results
POSTPrepare the session a new conversation's first message will use

Analytics

GETA page of candidates across the organisation
GETThe jobs and tags the analytics filters offer
GETOne row of funnel metrics per job in the organisation
GETA job's dashboard: its KPIs and candidate analytics
GETA job's headline hiring numbers
GETThe organisation's hiring overview
GETThe organisation's AI sourcing campaigns and how each is performing
POSTRun one read-only SELECT against the org-scoped analytics views

Application interview

POSTStart the AI interview
POSTRecord an interview anomaly such as a silent AI interviewer
POSTEnd the interview
POSTRecord that the candidate joined the interview
POSTCheck whether the interview has reached its end
POSTReport a problem with the application or interview
POSTRecord the outcome of the report-issue triage's self-help step

Applications

GETList a job's applications, a page at a time
POSTShortlist applications
POSTReject applications, optionally emailing each candidate
POSTScreen applications again
GETCount a job's applications by status and board column
GETList a job's deleted applications
GETList a job's applications, a page at a time
POSTCount how many of the given applications are still being screened
GETFind a job's applications whose resume mentions any of the terms
POSTStart an application to a job
PUTAttach an uploaded CV to the application
POSTReport a failed CV upload
POSTUpload the CV through the API
GETSign an upload URL for the CV
POSTConfirm a repeat application with its emailed code
POSTSend a fresh email verification code
GETCheck whether the application proceeds to the AI interview
GETGet the application's saved profile
PUTSave the application's profile and submit it

ATS

GETList the ATS integrations Alfa can connect to

ATS history

GETGet one person from the ATS history
POSTSearch the organisation's ATS history for people

ATS integration

GETGet the organisation's ATS integration
DELETEDisconnect the ATS and stop syncing with it
POSTCreate the link a recruiter opens to connect their ATS
POSTCreate the link that reconnects an expired or unfinished ATS connection
PATCHMap candidate statuses to ATS stages and switch the history sync
GETList the ATS's application stages
GETGet when the ATS and the ATS history last synced

Billing

POSTStart a checkout for a plan
GETList the company's invoices, newest first
GETList the company's issued invoices, a page at a time
POSTOpen the billing portal
POSTSubscribe to a plan, publishing a job afterwards when one is named
POSTCancel the company's subscription at the end of the billing period
POSTStart a free trial checkout

Candidate search demo

POSTStart a search of the synthetic candidate dataset
POSTStop a demo search
POSTVerify the next page of a demo search shortlist

Candidates

GETGet a candidate with their job, interview and company
DELETEDelete a candidate (restorable)
PUTReplace a candidate's CV with an uploaded file
GETList the emails exchanged with a candidate
PUTFavourite (shortlist) a candidate
DELETERemove a candidate from favourites
GETSuggest jobs whose location suits a location-blocked candidate
PUTRecord a reviewer's decision on an application held for manual review
POSTMove or copy a candidate to another job
GETList the recruiters' notes on a candidate
POSTAdd a note to a candidate
POSTRestore a deleted candidate
PATCHChange a candidate's pipeline status or board column
POSTSend emails Lisa drafted to candidates
GETOpen a shared candidate profile link

Connector

GETValidate an authorization request and describe it for the consent page
POSTAllow or deny a connection
GETList the caller's connected assistants in the active organisation
DELETEDisconnect an assistant

Dashboard PDF

GETGet a job dashboard's data for its PDF render

Developers

GETGet the Alfa API set-up
GETList Alfa API activity
GETList the company's API keys
POSTGenerate an API key
PATCHRename an API key
DELETERevoke an API key
POSTRotate an API key
PUTSet a key's webhook endpoint
DELETERemove a key's webhook endpoint
POSTRotate a webhook signing secret
POSTSend a test webhook event
GETList the platforms the company has authorized
POSTAuthorize a platform to act for the company
DELETERevoke a platform's authorization
GETList the ATS platforms a company can authorize
POSTSend a webhook event again
GETList the company's webhook deliveries
GETList the company's webhook endpoints

Exports

POSTStart exporting the organisation's candidates to an Excel workbook
GETRead the status of a candidate export, with its download link once built
POSTPreview the columns and first rows of the organisation's candidate export
POSTRender a job's dashboard as a PDF
POSTExport a job's candidates to an Excel workbook
POSTPreview the columns and first rows of a job's candidate export
POSTExport the organisation's jobs to an Excel workbook
POSTPreview the columns and first rows of the organisation's job export
POSTStart zipping the resumes in a job's selected pipeline columns
GETRead the status of a resume zip, with its download link once built

Files

GETGet a signed download link for a candidate's resume
GETGet where the screening evidence sits on a candidate's resume
GETGet signed images of a candidate's resume pages
GETGet the text layer of a candidate's resume
GETSign a short-lived URL for an uploaded file
POSTSign an upload of one file

Inbox

PUTMark inbox messages read or unread
GETList inbox conversations
GETGet a conversation with its participant, candidate, job and recent messages
GETList a conversation's messages
POSTSend the reply a recruiter confirmed
GETList inbox conversations, a page at a time

Interview bookings

GETGet the booking
POSTBook or reschedule the interview
POSTCancel the interview
GETGet the calendar file for the booked interview
POSTOpen the room early as the host
POSTGet the video room for the interview
GETList the bookable start times in a window

Interviews

GETGet the caller's connected calendar and the calendars it can count as busy
DELETEDisconnect the caller's calendar and revoke Alfa's access to it
POSTStart connecting the caller's calendar; returns the consent page to open
PUTChoose which of the connected calendars count as busy
POSTFinish connecting a calendar with the code and state from the consent page
GETList a candidate's interviews with their questions and transcripts
GETGet the caller's interview availability
PUTReplace the caller's interview availability
GETList the caller's interviews
POSTCancel an interview and tell the candidate
POSTStart an interview now and email the candidate a join link
GETGet a short-lived link to an interview's recording
GETPreview the booking page an interview stage's invitation opens
GETList the start times the preview's booking page offers in a window

Job board

PUTPut a candidate in a custom board column, or back in its default column
PATCHRename or move a custom board column, or change its call length
DELETEDelete a custom board column
GETThe caller's default candidate sort across jobs
PUTSet the caller's default candidate sort across jobs
GETList a job's audit history, newest first
GETWhether a job has any audit history
GETList a job's whole audit history, newest first, a page at a time
GETList a job's custom board columns with their candidate counts
POSTAdd a custom column to a job board
GETThe caller's column order and collapsed columns for a job's board
PATCHChange the caller's board layout for a job
POSTFind the candidates on a job's board that match a free-text search
GETThe caller's candidate sort and custom order on a job's board
PATCHChange the caller's candidate sort or custom order on a job's board
POSTFind the phrases of a candidate profile's text that match a free-text search

Job setup

GETThe jobs in the organisation's connected ATS
GETThe coordinates of a place in a country
POSTWrite a job advert
POSTEstimate how likely a job is to be filled
POSTRecommend changes that make a job more likely to be filled
GETThe fixed LinkedIn industry, job function or seniority options
GETStandard LinkedIn job titles matching typed text
GETPlaces matching typed text
GETThe advertising place for a named location
GETThe browser key for the advertising map

Jobs

GETList the jobs the caller can see
POSTCreate an empty job draft
GETGet a job
PUTSave a job
POSTSpend credits on more reach for a live job
POSTFill a new draft's seniority and LinkedIn labels
POSTClose a job
POSTCopy a job into a new draft
PUTPin a job to the sidebar
DELETEUnpin a job
POSTPublish a job
POSTReopen a closed job
POSTRun the final review's checks on an unsaved job draft
POSTWrite the draft change that clears one failed review check
GETGet a job's screening criteria
PATCHChange a job's screening criteria, and optionally re-screen its applicants
POSTSuggest screening-rule changes from the recruiters' decisions on a job
PATCHChange a job's team access, analytics, sourcing or tags
POSTWrite a new draft's advert
GETCount the jobs the caller can see
POSTCreate a complete job draft from a brief
GETList the jobs the caller can see, a page at a time
GETList the ids of the caller's pinned jobs

Me

GETGet the signed-in user
PATCHChange the signed-in user's name or profile picture
GETWhether the signed-in user is an Alfa admin, with their sign-in posture
GETGet the user's candidate panel tab order and last chosen tab
PUTRemember the candidate panel tab the user last chose
PUTSet the user's candidate panel tab order

Meetings

GETList the recorded meetings linked to a job
GETGet a recorded meeting with its summary and transcript

Newsletter

POSTSign up to the mailing list
POSTUnsubscribe with the token from an emailed link
GETCheck an unsubscribe link
POSTEmail an unsubscribe link

Omnibar search

POSTFind the candidates a Find query may mean
POSTCheck recalled candidates against a Find query
POSTDecide whether a Find query is a job or a candidate search

Organization

POSTCreate the caller's organisation and company
GETGet the caller's company, with its quota and cancellation state
PATCHChange the company's settings
GETGet the company's university and employer screening lists
GETGet the organisation's job posting and sourcing credit usage this billing cycle
GETGet the organisation's usage for one calendar month

Organization members

POSTInvite someone to join the organisation as a member
DELETERevoke a pending invitation
GETList the organisation's members and pending invitations
PATCHChange a member's role
DELETERemove a member from the organisation

Public jobs

GETList the jobs in the LinkedIn XML feed
GETList the ids of the live jobs, for the sitemap
GETGet a job's public page

Search

POSTSearch the organisation's candidates, jobs and teammates

Signup

GETResolve a signup voucher code

Sourced candidates

GETRead whether a job's outreach is paused
PUTPause a job's outreach
POSTAdd a person to a job by email or LinkedIn profile
POSTApprove outreach to a selection of a job's sourced profiles
GETFind a job's sourced profiles whose stored profile mentions any of the terms
GETGet a sourced profile
PATCHMove a sourced profile to a pipeline stage
POSTApprove outreach to a sourced profile
POSTLook up a sourced profile's contact details
GETList the emails exchanged with a sourced profile
POSTMove or copy a sourced profile to another job
GETRead whether a sourced profile's outreach is stopped
PUTStop a sourced profile's outreach
PUTChoose the email outreach is sent to
POSTReject a sourced profile
POSTReturn a rejected sourced profile to the sourced column
PATCHEdit a sourced profile's outreach sequence
GETWhich pending outreach emails can still be edited
GETRead the contact lookup for a LinkedIn profile
POSTStart a paid contact lookup for a LinkedIn profile

Status

GETCheck the API's health

Talent search

POSTSize the external talent pool for a role

Telemetry

POSTRecord a telemetry event

Tools

POSTWrite a candidate outreach message
POSTProfile a company from its website
POSTWrite an interview invitation email
POSTWrite role-specific interview questions
POSTWrite a job advert
POSTBenchmark salaries or contract day rates for a role and location

Error

`invalid_json`

HTTP 400. The request body is not valid JSON.

Send a JSON body with Content-Type: application/json.

All error codes