v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Candidate API:Candidates

Find candidates

get/candidates

Query parameters

CandidateIdinteger[]

Candidate Id

Namestring

Candidate name

Emailstring

Candidate email

Phonestring

Candidate phone or mobile number

CurrentPositionstring

Current Position

Citystring

City

Statestring

State

Locationstring

Location (city and/or state)

DateOfBirthstring date-time

Candidate date of birth available (ISO full-date)

Keywordsstring

Search for key-words within the latest candidate resume

PartnerAction.ActionIdstring[]

Unique identifier for partner actions

PartnerAction.Referencestring[]

Partner supplied unique reference for the action

PartnerAction.StagePartnerActionStage[]

Include partner actions at a specific stage

PartnerAction.SubmittedAtstring[]

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

StatusIdinteger[]

Candidate status

RecruiterUserIdinteger[]

User Id - search candidates by associated recruiters

FolderIdinteger[]

Search in specific folders

CreatedAtstring[]

Search for candidates created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

UpdatedAtstring[]

Search for candidates updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

Sortstring[]

Sort the results by one or multiple fields, prefix with "-" to sort descending.<br /> Default sort order is by candidateID in ascending order Fields available for sorting are: firstName, lastName, status.name, candidateId, createdAt, updatedAt

Fieldsstring[]

Additional fields to include with the results. Fields available to include are: recruiters, statistics

Embedstring[]

Embed related resources.<br /> Resources available to embed are: self, applications, placements, skills, notes

Offsetinteger

The index of the first entry to return from the resource collection

Limitinteger

The maximum number of entries to return.<br /> Setting to 0 will return only the total count of matching resources.

Response

List of candidates matching the specified criteria

totalCountinteger required