list_candidates
Fetch candidate records with date-range, ID, or email filters and paginate through results for bulk operations. Read-only access to list all candidates in batches.
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Filter by exact email address | ||
| cursor | No | Opaque cursor from a previous call's `next_cursor`, to fetch the next page. When set, all other filters are ignored — they are already baked into the cursor. | |
| 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 | |
| created_after | No | ISO 8601 datetime — only candidates created after this | |
| updated_after | No | ISO 8601 datetime — only candidates updated 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 |