v1
latestOpenAPI 3.0.12026-08-063985821.3 MBFind candidates
Query parameters
Candidate Id
Candidate name
Candidate email
Candidate phone or mobile number
Current Position
City
State
Location (city and/or state)
Candidate date of birth available (ISO full-date)
Search for key-words within the latest candidate resume
Unique identifier for partner actions
Partner supplied unique reference for the action
Include partner actions at a specific stage
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.
Candidate status
User Id - search candidates by associated recruiters
Search in specific folders
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.
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.
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
Additional fields to include with the results. Fields available to include are: recruiters, statistics
Embed related resources.<br /> Resources available to embed are: self, applications, placements, skills, notes
The index of the first entry to return from the resource collection
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