Leadline DocsToolsCandidates
searchCandidates
Generated from the Rover tool catalog. Do not edit by hand.
Read. This tool reads Leadline data and does not change it.
Live candidate search (max 5 results). Use for quick name/email lookup or autocomplete. Pass excludePositionId to skip people already on a position. For larger result sets or location, workflow, referrer, and channel filters, use list-candidates.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| query | string | no | Free-text search; omit when not filtering by text |
| tags | array | no | |
| company | string | no | |
| favorite | boolean | no | |
| positionId | unknown | no | Leadline entity id (unsigned bigint as digit string) |
| positionsIds | array | no | |
| excludePositionId | unknown | no | Omit candidates who already have a submission on this position |
| availabilityStatus | array | no |