List AI opt-out statuses

A candidate's decision to opt out of AI-assisted review (Talent Matching) for a specific job. Candidates opt out from the job post, confirming by emailed security code, and may do so before they ever apply — the decision is recorded against their email address and a job, not against a candidate record. Opt-out is per job: opting out of one job says nothing about any other job the same candidate applies to. A row appears only once the decision is confirmed and the candidate has an application on that job, and only the most recently confirmed decision per candidate and job is returned. Rows persist when a candidate opts back in, carrying opted_out: false, so a partner syncing on updated_at can observe the reversal — treat a candidate with no row at all as never having made a decision, not as having opted in. Behavioral notes: confirming an opt-out deletes any Talent Matching match scores already computed for that candidate on that job, except where a recruiter has manually overridden the match strength or the application has already been rejected or hired, and no further scores are computed. Because those applications then have no AI score, they remain in the job's "Needs manual review" queue for a recruiter to assess by hand rather than being filtered out of it. This endpoint never exposes match scores. Access requires the Talent Matching product; requests from organizations without it are rejected. Beyond the harvest:ai_opt_out_statuses:list scope, a user-scoped token must belong to a site admin or to a job admin whose level grants "Can view AI opt-out status" on the job, and is otherwise rejected rather than returned an empty list.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

integer
1 to 500
Defaults to 100

Number of results per page

ids
array of integers
length ≤ 50

Comma separated list

ids
created_at
object
updated_at
object
job_ids
array of integers
length ≤ 50

Comma separated list

job_ids
candidate_ids
array of integers
length ≤ 50

Comma separated list

candidate_ids
fields
array of strings
length ≤ 50

Comma separated list of fields to return

fields
boolean

Filter to candidates currently opted out (true) or to those who have confirmed opting back in (false). Omit to return every recorded decision.

Response

Language
Credentials
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json