list_candidates
List candidates in Greenhouse. By default returns a projected minimal view: per-candidate metadata only (id, last_activity_at, stage_snapshot, tag_ids, private). detail_profile=contact broadens the projection to include candidate name, primary contact fields, LinkedIn URL, location, and attachment metadata; signed attachment URLs remain opt-in via include_attachment_urls and require a reason.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Comma-separated candidate IDs to filter by | |
| tag | No | Filter by candidate tag name | |
| No | Filter by email address | ||
| cursor | No | Pagination cursor from a previous response. When provided, must be the only filter parameter. | |
| reason | No | Required when detail_profile requests a broadened response shape. | |
| private | No | Filter by private/confidential status | |
| per_page | No | Results per page (1-500, default 100) | |
| created_at | No | Filter by creation date. Format: operator|ISO8601 (e.g. gte|2024-01-01T00:00:00Z). Operators: gte, lte, gt, lt | |
| updated_at | No | Filter by update date. Format: operator|ISO8601 (e.g. gte|2024-01-01T00:00:00Z). Operators: gte, lte, gt, lt | |
| detail_profile | No | Projection profile. Default is minimal; contact broadens the candidate contact surface and requires a reason. | |
| last_activity_at | No | Filter by last activity date. Format: operator|ISO8601 (e.g. gte|2024-01-01T00:00:00Z). Operators: gte, lte, gt, lt | |
| custom_field_option_id | No | Filter by custom field option ID | |
| include_attachment_urls | No | Only valid with detail_profile=contact. When true, includes signed attachment URLs. |