Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Ats > Candidate

Reads all Candidates

Fetches candidates data from Factorial. When using administrator-level API Credentials, all candidates associated with a company will be returned. When using non-admin level API credentials, only candidates that applied to a job for which the user is a hiring manager will be returned.

get/api/2026-07-01/resources/ats/candidates

Query parameters

ids[]string[]

list of candidate identifiers.

list of candidate identifiers.

[
  "1",
  "2",
  "3"
]
emails[]string[]

list of candidate emails.

list of candidate emails.

[
  "ana@factorial.com",
  "juan@factorial.com"
]
team_ids[]string[]

list of team identifiers, refers to teams/teams endpoint.

list of team identifiers, refers to teams/teams endpoint.

[
  "1",
  "2",
  "3"
]
location_ids[]string[]

list of location identifiers, refers to locations/locations endpoint.

list of location identifiers, refers to locations/locations endpoint.

[
  "1",
  "2",
  "3"
]
source[]string[]

source of the candidate.

source of the candidate.

remoteboolean

is the candidate remote?

Example:true

is the candidate remote?

job_posting_ids[]string[]

list of job posting identifiers, refers to ats/job_postings endpoint.

list of job posting identifiers, refers to ats/job_postings endpoint.

[
  "1",
  "2",
  "3"
]
minimum_average_ratingnumber

minimum average rating of the candidate.

Example:4

minimum average rating of the candidate.

activeboolean

is the candidate active?

Example:true

is the candidate active?

talent_poolboolean

is the candidate part of talent pool?

Example:true

is the candidate part of talent pool?

archivedboolean

is the candidate archived?

Example:true

is the candidate archived?

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "company_id": "1",
      "first_name": "Ana",
      "last_name": "Fernandez Perez",
      "full_name": "Ana Fernandez Perez",
      "email": "ana@factorial.com",
      "talent_pool": true,
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "consent_given_at": "2021-01-01T00:00:00Z",
      "inactive_since": "2021-01-01T00:00:00Z",
      "ats_job_posting_ids": [
        "1",
        "2",
        "3"
      ],
      "personal_url": "https://anaperez.factorial.com",
      "consent_expiration_date": "2021-01-01T00:00:00Z",
      "consent_to_talent_pool": true,
      "medium": "email",
      "source_id": "1",
      "gender": "female",
      "score": 7
    }
  ]
}