hires_list_candidates
List and filter candidates by job, stage, email, name, LinkedIn, or creation/update dates. Get paginated results to view and manage applicant data.
Instructions
List candidates with optional filters. Supports filtering by job, stage, email, name, LinkedIn, and date ranges. Returns paginated results.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Plain-text search by name or email. Supports partial matches. | |
| page | No | Page number (1-based). | |
| size | No | Number of items per page. | |
| No | Exact candidate email filter. | ||
| job_id | No | Filter candidates by job ID. | |
| include | No | Comma-separated list of optional related data to include in the response. | |
| No | Search by LinkedIn profile URL or alias (e.g. 'johndoe' or full URL). | ||
| stage_id | No | Filter candidates by pipeline stage ID. Best used together with job_id. | |
| full_name | No | Candidate full-name filter. | |
| company_id | No | Filter by company ID. Required only when the API key has access to multiple companies. | |
| created_after | No | Return only candidates created after this Unix timestamp (seconds). | |
| updated_after | No | Return only candidates updated after this Unix timestamp (seconds). Useful for incremental sync. |