Leadline DocsToolsCandidates
listCandidates
Generated from the Rover tool catalog. Do not edit by hand.
Read. This tool reads Leadline data and does not change it.
Paginated candidate list with contact fields and tags. Use when the user names a position, hiring stage, company, tag, location, workflow, referrer, or channel. Pass those filters on the first call. excludePositionId drops people already submitted to that position. Default limit is 10. Do not page an unfiltered catalog and filter in the reply.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| query | string | no | Free-text search; omit when not filtering by text |
| positionsIds | array | no | |
| positionId | unknown | no | Leadline entity id (unsigned bigint as digit string) |
| excludePositionId | unknown | no | Omit candidates who already have a submission on this position |
| candidatesIds | array | no | Filter to these candidate ids |
| hiringStagesIds | array | no | Hiring Stage process ids. Pass "null" for Incomplete. |
| tags | array | no | |
| company | string | no | |
| companies | array | no | Current employer names |
| favorite | boolean | no | |
| availabilityStatus | array | no | |
| positionsLocationsIds | array | no | Candidates with a submission whose position is in these locations |
| workflowsIds | array | no | Hiring workflow ids |
| referrersIds | array | no | |
| channelsSlugs | array | no | Submission channel slugs |
| sortBy | string | no | Sort e.g. Candidate.firstName+desc |
| skip | integer | no | Pagination offset (default 0) |
| limit | integer | no | Page size (default 10) |