list_candidates
Retrieve candidate profiles in bulk using date-range, ID, tag, or email filters, and paginate through results for full-database scans. Read-only.
Instructions
List candidates with optional filters. Read-only.
For finding a specific person, use search_candidates_by_name (by name) or search_candidates_by_email (by email) — faster and simpler. Use this tool for bulk operations: date-range queries, fetching by specific IDs, or paginating through the full database. Created and updated date filters can't be combined in one call. Candidates here are profile-only (no applications or attachments) — use get_candidate or list_applications(candidate_id=...) for those.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Filter by exact candidate tag name | |
| No | Filter by exact email address | ||
| cursor | No | Pass next_cursor from the previous response to get the next page | |
| paginate | No | 'single' for one page, 'all' to auto-fetch every page | single |
| per_page | No | Results per page (max 500) | |
| candidate_ids | No | Filter to specific candidate IDs (max 50) | |
| created_after | No | ISO 8601 datetime — only candidates created at/after this | |
| updated_after | No | ISO 8601 datetime — only candidates updated at/after this | |
| created_before | No | ISO 8601 datetime — only candidates created before this | |
| updated_before | No | ISO 8601 datetime — only candidates updated before this |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |