External DocumentationTo learn more, visit the Greenhouse documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Candidate ID | The ID of the candidate. |
| Company | The company of the candidate. |
| First Name | The first name of the candidate. |
| Is Private | Select to make the candidate private. |
| Last Name | The last name of the candidate. |
| Preferred Name | The preferred or chosen name of the candidate, when different from their legal first name. |
| Time Zone | The Rails-style timezone identifier of the candidate. For example: Eastern Time (US & Canada). |
| Title | The title of the candidate. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Addresses | A json array of addresses. For example: |
| Can Email | Select to indicate the candidate has consented to email communication. |
| Custom Fields | A json array of custom field objects, identified by custom_field_id or name_key, with the new value.For example: |
| Email Addresses | A json array of email addresses. For example: |
| Linked User IDs | A comma-separated list of user IDs to link to the candidate. |
| Phone Numbers | A json array of phone numbers. For example: |
| Social Media Addresses | A json array of social media addresses. For example: |
| Tags | A comma-separated list of tags to associated with the candidate. |
| Website Addresses | A json array of website addresses. For example: |
Example Output
{
"id": 53883394,
"first_name": "New",
"last_name": "Name",
"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:54:34.257Z",
"can_email": true,
"time_zone": null,
"last_activity_at": "2017-09-28T12:54:34.243Z",
"private": true,
"tags": [
"Walkabout",
"Orientation"
],
"linked_user_ids": [],
"phone_numbers": [
{
"value": "555-1212",
"type": "mobile"
}
],
"addresses": [
{
"value": "123 Fake St.",
"type": "home"
}
],
"email_addresses": [
{
"value": "john.locke+work@example.com",
"type": "work"
},
{
"value": "john.locke@example.com",
"type": "personal"
}
],
"website_addresses": [
{
"value": "johnlocke.example.com",
"type": "personal"
}
],
"social_media_addresses": [
{
"value": "linkedin.example.com/john.locke"
}
],
"custom_fields": {
"single_select_field_name": {
"name": "Single Select Field Name",
"type": "single_select",
"value": 12345
}
}
}