This object includes the details of the candidate who is hired and the details of the position that they are hired for.
| Field | Type | Description |
|---|---|---|
| recruit_id | string | Unique candidate ID |
| person_uid | string | Unique ID of the person. Each person can have multiple candidate objects, each represents a separate hiring process |
| first_name | string | |
| middle_name | string | |
| last_name | string | |
| string | ||
| time_created | timestamp | YYYY-MM-DDTHH:mm:ssZ |
| phone | string | |
| mobile_phone | string | |
| id_number | string | |
| linkedin_url | string | |
| source | object | null if the candidate doesn't have a source defined |
| source.name | string | |
| source.type | string | One of the following: Agency Campus Comeet Elastic Recruiting Internal Job Board Job fairs Other Referrer: Compensated Referrer: Uncompensated Social network Sourcing Web |
| source.recruit_id | string | Unique source ID |
| resume | object | |
| resume.name | string | |
| resume.url | string | A public URL for the candidate resume. The link will expire three minutes after being delivered. |
| picture | object | |
| picture.url | string | A public URL for the candidate profile picture. The link will expire 200 seconds after being delivered. |
| links | array | |
| links[].url | string | |
| files[] | array | |
| files[].name | string | |
| files[].url | string | |
| files[].type | string | Only files of type "offer_letter" are supported |
| opening.description | opening name | |
| opening.reason | ||
| opening.custom_fields | object | Key-value pairs of the custom opening fields. |
| position | object | |
| position.recruit_id | string | Unique position ID |
| position.name | string | Internal position name |
| position.public_name | string | Public facing name of the position, if different from position.name. If not defined then the value will be null |
| position.department | string | |
| position.description | HTML | |
| position.requirements | HTML | |
| position.position_id | string | The position id that was set by the costumer. may also be null or empty string. Not to be confused with position.recruit_id |
| position.location | string | |
| position.employment | string | |
| position.employee_type | string | One of the following: Outsource Headcount Intern null |
| position.seniority | string | |
| position.hiring_manager | object | |
| position.hiring_manager.first_name | string | |
| position.hiring_manager.last_name | string | |
| position.hiring_manager.email | string | |
| position.leading_recruiter | object | |
| position.leading_recruiter.first_name | string | |
| position.leading_recruiter.last_name | string | |
| position.leading_recruiter.email | string | |
| position.custom_fields | object | Key-value pairs of public custom position category fields. Note that default fields (department, location, etc) are part of the position object |
| custom_fields | object | Key-value pairs of custom candidate fields |
| offer_fields | array | Key-value pairs of the offer fields |
| internal_offer_fields | array | Key-value pairs of the internal offer fields |