Candidate data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The candidate's full name |
first_name | string | No | |
last_name | string | No | |
emails | AtsEmail[] | No | The candidate's email addresses |
emails[].name | string | No | |
emails[].email | string | Yes | |
emails[].type | enum | No | Values: WORK, HOME, OTHER |
title | string | No | Candidate’s current job title |
telephones | AtsTelephone[] | No | |
telephones[].telephone | string | Yes | |
telephones[].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE |
company_name | string | No | Name of company where candidate currently works |
image_url | string | No | |
tags | string[] | No | |
address | object | No | |
address.address1 | string | No | |
address.address2 | string | No | |
address.city | string | No | |
address.region | string | No | Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province. |
address.region_code | string | No | Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province. |
address.postal_code | string | No | |
address.country | string | No | |
address.country_code | string | No | Country code for the country, in ISO 3166 A-2 format |
external_identifier | string | No | |
link_urls | string[] | No | URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.) |
origin | enum | No | Values: AGENCY, APPLIED, INTERNAL, REFERRED, SOURCED, UNIVERSITY |
company_id | string | No | (reference to AtsCompany) |
sources | string[] | No | |
date_of_birth | string (date-time) | No | |
user_id | string | No | Employee ID that owns the relationship for this candidate (reference to HrisEmployee) |
user_ids | string[] | No | references hris employees |
web_url | string | No | |
experiences | AtsCandidateExperience[] | No | |
experiences[].company_name | string | No | |
experiences[].title | string | No | |
experiences[].start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
experiences[].end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
education | AtsCandidateEducation[] | No | |
education[].institution | string | No | |
education[].level | string | No | |
education[].degree | string | No | |
education[].field_of_study | string | No | |
education[].start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
education[].end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
skills | string[] | No | |
job_ids | string[] | No | |
metadata | AtsMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
summary | string | No | Personal / professional bio |
is_private | boolean | No | Whether the candidate is confidential / private (visible only to permitted users) |
has_do_not_contact | boolean | No | Whether the candidate must not be contacted for outreach |
Are we missing anything? Let us know
Was this page helpful?