list_candidates
Retrieve candidate records using filters for date ranges, IDs, and pagination, enabling bulk data operations in Greenhouse.
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 |
|---|---|---|---|
| page | No | Page number (starts at 1) | |
| No | Filter by exact email address | ||
| 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 |