External DocumentationTo learn more, visit the Greenhouse documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Cursor | A cursor for use in pagination, taken from the Link header of a previous response. Cannot be combined with any other parameter. |
| Custom Field Option ID | Return only candidates whose single-select or multi-select custom field value matches this option ID. |
Return only candidates with this email address on their profile. If both email and IDs are included, then IDs will be ignored. | |
| Fields | A comma separated list of specific candidate fields to return (up to 50). |
| IDs | A comma separated list of candidate IDs to retrieve (up to 50). If both email and IDs are included, then IDs will be ignored. |
| Per Page | The maximum number of results to return per page. Maximum is 500. |
| Private | Select to include private candidates in the results. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Tag | Filter by candidate tag name. Requires an exact match. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Created At (Greater Than or Equal) | The date and time on or after which candidates were created. |
| Created At (Greater Than) | The date and time after which candidates were created. |
| Created At (Less Than or Equal) | The date and time on or before which candidates were created. |
| Created At (Less Than) | The date and time before which candidates were created. |
| Last Activity At (Greater Than or Equal) | The date and time on or after which candidates’ applications had their last activity. |
| Last Activity At (Greater Than) | The date and time after which candidates’ applications had their last activity. |
| Last Activity At (Less Than or Equal) | The date and time on or before which candidates’ applications had their last activity. |
| Last Activity At (Less Than) | The date and time before which candidates’ applications had their last activity. |
| Updated At (Greater Than or Equal) | The date and time on or after which candidates were updated. |
| Updated At (Greater Than) | The date and time after which candidates were updated. |
| Updated At (Less Than or Equal) | The date and time on or before which candidates were updated. |
| Updated At (Less Than) | The date and time before which candidates were updated. |
Example Output
[
{
"id": 53883394,
"first_name": "John",
"last_name": "Locke",
"preferred_name": null,
"company": "The Tustin Box Company",
"title": "Customer Success Representative",
"created_at": "2017-08-15T03:31:46.591Z",
"updated_at": "2017-09-28T12:29:30.497Z",
"can_email": true,
"time_zone": "Eastern Time (US & Canada)",
"last_activity_at": "2017-09-28T12:29:30.481Z",
"private": false,
"tags": [
"Python",
"Ruby"
],
"linked_user_ids": [
989604
],
"phone_numbers": [
{
"value": "555-555-5555",
"type": "mobile"
}
],
"addresses": [
{
"value": "123 City Street\nNew York, Ny 10001",
"type": "home"
}
],
"email_addresses": [
{
"value": "test@work.com",
"type": "work"
}
],
"website_addresses": [
{
"value": "mysite.com",
"type": "personal"
}
],
"social_media_addresses": [],
"custom_fields": {
"graduation_year": {
"name": "Graduation Year",
"type": "single_select",
"value": "2018"
}
}
}
]