Deel: People schemas
69 Deel schemas with complete fields and constraints.
← People operations · All schemas
Create a direct employee — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a direct employee — 201 response body — data |
Referenced models: Create a direct employee — 201 response body — data
Create a direct employee — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
compensation_details | Model | Required within parent | Expand Create a direct employee — 201 response body — data compensation details The compensation details of the employee |
employee | Model | Required within parent | Expand Create a direct employee — 201 response body — data employee The person that is being hired |
employment | Model | Required within parent | Expand Create a direct employee — 201 response body — data employment The employment details of the employee |
id | string | Required within parent | The unique identifier of the created employee record Format: uuid |
Referenced models: Create a direct employee — 201 response body — data compensation details, Create a direct employee — 201 response body — data employee, Create a direct employee — 201 response body — data employment
Create a direct employee — 201 response body — data compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The compensation details of the employee |
currency | string | Required within parent | The currency of the salary Maximum length: 3 Minimum length: 3 |
salary | string | Required within parent | The salary of the employee |
scale | string | Optional | The scale at which the salary is paid Known values: ANNUAL, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY Default: ANNUAL |
Create a direct employee — 201 response body — data employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The person that is being hired |
email | string | Required within parent | The personal email of the person being hired Format: email Maximum length: 255 Minimum length: 3 |
external_id | string | Optional | An external identifier for the person being hired |
first_name | string | Required within parent | The first name of the person being hired Maximum length: 100 Minimum length: 3 |
last_name | string | Required within parent | The last name of the person being hired Maximum length: 100 Minimum length: 3 |
nationality | string | Required within parent | The nationality of the person being hired Maximum length: 2 Minimum length: 2 |
work_email | string | Optional | The work email of the person being hired Format: email Maximum length: 255 Minimum length: 3 |
Create a direct employee — 201 response body — data employment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The employment details of the employee |
contract_id | string | Required within parent | The unique identifier of the worker contract |
country | string | Required within parent | The country of the employment Maximum length: 2 Minimum length: 2 |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | The end date of the employment. `null` for open-ended employments. Format: date |
end_date (anyOf 2) | null | Alternative | The end date of the employment. `null` for open-ended employments. Format: date |
job_title | string | Required within parent | The job title of the employment |
part_time_percentage | JSON | Optional | |
part_time_percentage (anyOf 1) | number | Alternative | The percentage of PART_TIME employment Format: double Maximum: 99 Minimum: 1 |
part_time_percentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
seniority | string | Required within parent | The seniority of the employment |
start_date | string | Required within parent | The start date of the employment Format: date |
type | string | Required within parent | The type of employment Known values: FULL_TIME, PART_TIME |
Create a direct employee — request body — body / data / employment / type: FULL TIME
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
document_template_id | string | Optional | The document template ID for the employment contract Format: uuid |
end_date | string | Optional | The end date of the employment Format: date |
job_title | string | Required within parent | The job title of the employment |
seniority | string | Required within parent | The seniority of the employment |
start_date | string | Required within parent | The start date of the employment Format: date |
type | string | Required within parent | The type of employment One of: FULL_TIME |
Create a direct employee — request body — body / data / employment / type: PART TIME
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
document_template_id | string | Optional | The document template ID for the employment contract Format: uuid |
end_date | string | Optional | The end date of the employment Format: date |
job_title | string | Required within parent | The job title of the employment |
part_time_percentage | number | Required within parent | The percentage of PART_TIME employment Format: double Maximum: 99 Minimum: 1 |
seniority | string | Required within parent | The seniority of the employment |
start_date | string | Required within parent | The start date of the employment Format: date |
type | string | Required within parent | The type of employment One of: PART_TIME |
Create a direct employee — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | Model | Required within parent | Expand Create a direct employee — request body — body data client The entity that is hiring the employee |
compensation_details | Model | Required within parent | Expand Create a direct employee — request body — body data compensation details The compensation details of the employee |
employee | Model | Required within parent | Expand Create a direct employee — request body — body data employee The person that is being hired |
employment | Model | Required within parent | Expand Create a direct employee — request body — body data employment The employment details of the employee |
invitation | Model | Optional | Expand Create a direct employee — request body — body data invitation Optional invitation configuration for the new hire. Defaults to 'IMMEDIATE' if not provided. |
Referenced models: Create a direct employee — request body — body data client, Create a direct employee — request body — body data compensation details, Create a direct employee — request body — body data employee, Create a direct employee — request body — body data employment, Create a direct employee — request body — body data invitation
Create a direct employee — request body — body data client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The entity that is hiring the employee |
department | Model | Optional | Expand Create a direct employee — request body — body data client department The department information for the employee |
legal_entity | Model | Required within parent | Expand Create a direct employee — request body — body data client legal entity The legal entity information for the employee |
team | Model | Required within parent | Expand Create a direct employee — request body — body data client team The team information for the employee |
Referenced models: Create a direct employee — request body — body data client department, Create a direct employee — request body — body data client legal entity, Create a direct employee — request body — body data client team
Create a direct employee — request body — body data client department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The department information for the employee |
id | string | Required within parent | The department that the employee is part of Format: uuid |
Create a direct employee — request body — body data client legal entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The legal entity information for the employee |
id | string | Required within parent | The legal entity that the employee is part of Format: uuid |
Create a direct employee — request body — body data client team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The team information for the employee |
direct_manager_id | string | Optional | The direct manager of the employee Format: uuid |
id | string | Required within parent | The team that the employee is part of Format: uuid |
Create a direct employee — request body — body data compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The compensation details of the employee |
currency | string | Required within parent | The currency of the salary Maximum length: 3 Minimum length: 3 |
salary | string | Required within parent | The salary of the employee |
scale | string | Optional | The scale at which the salary is paid Default: ANNUAL One of: ANNUAL, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY |
Create a direct employee — request body — body data employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The person that is being hired |
country | string | Required within parent | The country of the person being hired Maximum length: 2 Minimum length: 2 |
email | string | Required within parent | The personal email of the person being hired Format: email Maximum length: 255 Minimum length: 3 |
external_id | string | Optional | An external identifier for the person being hired |
first_name | string | Required within parent | The first name of the person being hired Maximum length: 100 Minimum length: 3 |
last_name | string | Required within parent | The last name of the person being hired Maximum length: 100 Minimum length: 3 |
nationality | string | Required within parent | The nationality of the person being hired Maximum length: 2 Minimum length: 2 |
state | string | Optional | The state of the person being hired Maximum length: 50 Minimum length: 1 |
work_email | string | Optional | The work email of the person being hired Format: email Maximum length: 255 Minimum length: 3 |
Create a direct employee — request body — body data employment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The employment details of the employee |
$ (oneOf 1) | Model | Alternative | Expand Create a direct employee — request body — body / data / employment / type: PART TIME |
$ (oneOf 2) | Model | Alternative | Expand Create a direct employee — request body — body / data / employment / type: FULL TIME |
Referenced models: Create a direct employee — request body — body / data / employment / type: PART TIME, Create a direct employee — request body — body / data / employment / type: FULL TIME
Create a direct employee — request body — body data invitation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Optional invitation configuration for the new hire. Defaults to 'IMMEDIATE' if not provided. |
action | string | Optional | Controls whether to send an invitation email. One of: DISABLE, IMMEDIATE |
Create a person without a contract — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a person without a contract — 201 response body — data |
Referenced models: Create a person without a contract — 201 response body — data
Create a person without a contract — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The id of the person Format: uuid |
person | Model | Required within parent | Expand Create a person without a contract — 201 response body — data person The person that is being hired |
Referenced models: Create a person without a contract — 201 response body — data person
Create a person without a contract — 201 response body — data person
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The person that is being hired |
country | string | Optional | The country of the person being hired Maximum length: 2 Minimum length: 2 |
email | string | Required within parent | The personal email of the person being hired Format: email |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The end date of the person being hired Format: date |
end_date (anyOf 2) | null | Alternative | The end date of the person being hired Format: date |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | An external identifier for the person being hired |
external_id (anyOf 2) | null | Alternative | An external identifier for the person being hired |
first_name | string | Required within parent | The first name of the person being hired |
job_title | string | Optional | The job title of the person being hired |
last_name | string | Required within parent | The last name of the person being hired |
nationality | string | Optional | The nationality of the person being hired Maximum length: 2 Minimum length: 2 |
seniority | string | Optional | The seniority of the person being hired |
start_date | string | Required within parent | The start date of the person being hired Format: date |
state | string | Optional | The state of the person being hired Maximum length: 50 Minimum length: 1 |
work_email | string | Optional | The work email of the person being hired Format: email |
worker_id | JSON | Optional | |
worker_id (anyOf 1) | number | Alternative | The worker ID of the person being hired Format: double |
worker_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create a person without a contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | Model | Required within parent | Expand Create a person without a contract — request body — body data client |
invitation | Model | Optional | Expand Create a person without a contract — request body — body data invitation Optional invitation configuration for the new hire. Defaults to 'disable' if not provided. |
person | Model | Required within parent | Expand Create a person without a contract — request body — body data person The person that is being hired |
Referenced models: Create a person without a contract — request body — body data client, Create a person without a contract — request body — body data invitation, Create a person without a contract — request body — body data person
Create a person without a contract — request body — body data client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department | Model | Optional | Expand Create a person without a contract — request body — body data client department |
legal_entity | Model | Required within parent | Expand Create a person without a contract — request body — body data client legal entity |
team | Model | Required within parent | Expand Create a person without a contract — request body — body data client team |
Referenced models: Create a person without a contract — request body — body data client department, Create a person without a contract — request body — body data client legal entity, Create a person without a contract — request body — body data client team
Create a person without a contract — request body — body data client department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The department that the person is part of Format: uuid |
Create a person without a contract — request body — body data client legal entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The legal entity that the person is part of Format: uuid |
Create a person without a contract — request body — body data client team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
direct_manager_id | string | Optional | The direct manager of the person Format: uuid |
direct_reports_ids | array | Optional | The direct reports of the person |
direct_reports_ids[] | string | Each item | Format: uuid |
id | string | Required within parent | The team that the person is part of Format: uuid |
Create a person without a contract — request body — body data invitation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Optional invitation configuration for the new hire. Defaults to 'disable' if not provided. |
action | string | Optional | Controls whether to send an invitation email. One of: DISABLE, IMMEDIATE |
Create a person without a contract — request body — body data person
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The person that is being hired |
address | Model | Optional | Expand Create a person without a contract — request body — body data person address The home address of the person being hired |
country | string | Optional | The country of the person being hired Maximum length: 2 Minimum length: 2 |
email | string | Required within parent | The personal email of the person being hired Format: email Maximum length: 255 Minimum length: 3 |
end_date | string | Optional | The end date of the person being hired Format: date |
external_id | string | Optional | An external identifier for the person being hired Maximum length: 100 |
first_name | string | Required within parent | The first name of the person being hired Maximum length: 100 Minimum length: 1 |
job_title | string | Optional | The job title of the person being hired Maximum length: 255 |
last_name | string | Required within parent | The last name of the person being hired Maximum length: 100 Minimum length: 1 |
nationality | string | Optional | The nationality of the person being hired Maximum length: 2 Minimum length: 2 |
preferred_first_name | string | Optional | The preferred first name of the person being hired Maximum length: 100 Minimum length: 1 |
preferred_last_name | string | Optional | The preferred last name of the person being hired Maximum length: 100 Minimum length: 1 |
seniority | string | Optional | The seniority of the person being hired Maximum length: 255 |
start_date | string | Required within parent | The start date of the person being hired Format: date |
state | string | Optional | The state of the person being hired Maximum length: 50 Minimum length: 1 |
work_email | string | Optional | The work email of the person being hired Format: email Maximum length: 255 Minimum length: 3 |
Referenced models: Create a person without a contract — request body — body data person address
Create a person without a contract — request body — body data person address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The home address of the person being hired |
city | string | Optional | The city of the home address |
country | string | Required within parent | The country of the home address as an ISO 3166-1 alpha-2 code Maximum length: 2 Minimum length: 2 |
line_two | string or null | Optional | The second line of the home address |
state | string or null | Optional | The state or province of the home address |
street | string | Optional | The street and number of the home address |
zip | string | Optional | The postal code of the home address |
Get my current personal profile — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | People object representing a Deel |
avatar_url | JSON | Optional | |
avatar_url (anyOf 1) | string | Alternative | URL of the user's avatar |
avatar_url (anyOf 2) | null | Alternative | URL of the user's avatar |
client_country | JSON | Optional | |
client_country (anyOf 1) | string | Alternative | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
client_country (anyOf 2) | null | Alternative | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
contractor_country | JSON | Optional | |
contractor_country (anyOf 1) | string | Alternative | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
contractor_country (anyOf 2) | null | Alternative | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
email | string | Optional | Email address of the user |
first_name | string | Optional | First name of the user |
full_name | string | Optional | Full name of the user |
hris_enabled | JSON | Optional | |
hris_enabled (anyOf 1) | boolean | Alternative | HRIS feature enabled. |
hris_enabled (anyOf 2) | null | Alternative | HRIS feature enabled. |
hris_organization_user_id | JSON | Optional | |
hris_organization_user_id (anyOf 1) | string | Alternative | HRIS Organization User ID of the user. Used in products like Deel Engage. Format: uuid |
hris_organization_user_id (anyOf 2) | null | Alternative | HRIS Organization User ID of the user. Used in products like Deel Engage. Format: uuid |
id | JSON | Optional | |
id (anyOf 1) | number | Alternative | Unique identifier for the user profile Format: double |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
last_name | string | Optional | Last name of the user |
middle_name | JSON | Optional | |
middle_name (anyOf 1) | string | Alternative | Middle name of the user |
middle_name (anyOf 2) | null | Alternative | Middle name of the user |
organization_id | JSON | Optional | |
organization_id (anyOf 1) | number | Alternative | Unique identifier for the organization Format: double |
organization_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
organization_name | JSON | Optional | |
organization_name (anyOf 1) | string | Alternative | Name of the organization |
organization_name (anyOf 2) | null | Alternative | Name of the organization |
profile_type | string | Optional | Type of profile Known values: client, contractor, icp, direct_employee, hris_direct_employee, peo_employee, service_account |
slack_team_id | JSON | Optional | |
slack_team_id (anyOf 1) | string | Alternative | User's team slack id |
slack_team_id (anyOf 2) | null | Alternative | User's team slack id |
slack_user_id | JSON | Optional | |
slack_user_id (anyOf 1) | string | Alternative | User's slack id |
slack_user_id (anyOf 2) | null | Alternative | User's slack id |
user_id | JSON | Optional | |
user_id (anyOf 1) | number | Alternative | Unique identifier for the user Format: double |
user_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
username | string | Optional | Username of the user |
List of People — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List of People — 200 response body — data item |
page | Model | Optional | Expand List of People — 200 response body — page |
Referenced models: List of People — 200 response body — data item, List of People — 200 response body — page
List of People — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active_worker_termination_status | JSON | Optional | The status of the active worker termination. |
active_worker_termination_status (anyOf 1) | string | Alternative | The status of the active worker termination. Known values: PENDING, CONTRACT_TERMINATION_DATA_COLLECTED, IN_PROGRESS, COMPLETED, FAILED, CANCELED |
active_worker_termination_status (anyOf 2) | null | Alternative | |
additional_details | JSON | Optional | |
additional_details (anyOf 1) | array | Alternative | Country-scoped additional employment data points (national IDs, tax IDs, etc.) sourced from hris_employment_eligibility.eligibility_data. Returned only when the caller's organization has the feature flag enable and the request is not redacting PII. |
additional_details (anyOf 1)[] | Model | Each item | Expand Retrieve a single person — 200 response body — data additional details null item |
additional_details (anyOf 2) | null | Alternative | Country-scoped additional employment data points (national IDs, tax IDs, etc.) sourced from hris_employment_eligibility.eligibility_data. Returned only when the caller's organization has the feature flag enable and the request is not redacting PII. |
additional_details (anyOf 2)[] | Model | Each item | Expand Retrieve a single person — 200 response body — data additional details null item |
addresses | JSON | Optional | |
addresses (anyOf 1) | array | Alternative | An array of address objects containing the employee's physical addresses. |
addresses (anyOf 1)[] | Model | Each item | Expand List of People — 200 response body — data item addresses null item |
addresses (anyOf 2) | null | Alternative | An array of address objects containing the employee's physical addresses. |
addresses (anyOf 2)[] | Model | Each item | Expand List of People — 200 response body — data item addresses null item |
birth_date | JSON | Optional | |
birth_date (anyOf 1) | string | Alternative | The birth date of the employee. |
birth_date (anyOf 2) | null | Alternative | The birth date of the employee. |
client_legal_entity | Model | Optional | Expand Retrieve a single person — 200 response body — data client legal entity The primary client legal entity associated with the employee. |
completion_date | JSON | Optional | |
completion_date (anyOf 1) | string | Alternative | The completion date of the task or project. |
completion_date (anyOf 2) | null | Alternative | The completion date of the task or project. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The country of the employee. |
country (anyOf 2) | null | Alternative | The country of the employee. |
created_at | string | Optional | The creation timestamp of the employee record. Format: date-time |
department | Model | Optional | Expand List of People — 200 response body — data item department The department of the employee. |
direct_employee_termination_last_day | string | Optional | The last day of work mentioned on the primary contract termination. Format: date-time |
direct_manager | JSON | Optional | The direct manager of the employee. |
direct_manager (anyOf 1) | Model | Alternative | Expand List of People — 200 response body — data item direct manager The direct manager of the employee |
direct_manager (anyOf 2) | null | Alternative | |
direct_reports | JSON | Optional | |
direct_reports (anyOf 1) | array | Alternative | The direct reports to the employee. |
direct_reports (anyOf 1)[] | Model | Each item | Expand List of People — 200 response body — data item direct reports The direct reports to the employee item |
direct_reports (anyOf 2) | null | Alternative | The direct reports to the employee. |
direct_reports (anyOf 2)[] | Model | Each item | Expand List of People — 200 response body — data item direct reports The direct reports to the employee item |
direct_reports_count | JSON | Optional | |
direct_reports_count (anyOf 1) | integer | Alternative | The count of direct reports to the employee. |
direct_reports_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
emails | JSON | Optional | |
emails (anyOf 1) | array | Alternative | An array of the employee's email addresses. |
emails (anyOf 1)[] | Model | Each item | Expand List of People — 200 response body — data item emails An array of the employee's email addresses item |
emails (anyOf 2) | null | Alternative | An array of the employee's email addresses. |
emails (anyOf 2)[] | Model | Each item | Expand List of People — 200 response body — data item emails An array of the employee's email addresses item |
employments | JSON | Optional | |
employments (anyOf 1) | array | Alternative | An array of employment records associated with the employee, including contract details, team information, payment details, and employment status. |
employments (anyOf 1)[] | Model | Each item | Expand List of People — 200 response body — data item employments null item |
employments (anyOf 2) | null | Alternative | An array of employment records associated with the employee, including contract details, team information, payment details, and employment status. |
employments (anyOf 2)[] | Model | Each item | Expand List of People — 200 response body — data item employments null item |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | The external ID of the employee. |
external_id (anyOf 2) | null | Alternative | The external ID of the employee. |
first_name | string | Optional | The first name of the employee. |
full_name | string | Optional | The full name of the employee. |
hiring_status | string | Optional | The current hiring status of the employee. |
hiring_type | JSON | Optional | |
hiring_type (anyOf 1) | string | Alternative | The type of hiring of the employee. |
hiring_type (anyOf 2) | null | Alternative | The type of hiring of the employee. |
hris_organization_user_id | JSON | Optional | |
hris_organization_user_id (anyOf 1) | string | Alternative | HRIS Organization User ID of the employee. Used in products like Deel Engage. Format: uuid |
hris_organization_user_id (anyOf 2) | null | Alternative | HRIS Organization User ID of the employee. Used in products like Deel Engage. Format: uuid |
id | string | Optional | Unique identifier for the employee. |
is_pwac | boolean | Optional | Whether the worker is a Person Without a Contract (PWAC) |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | The job title of the employee. |
job_title (anyOf 2) | null | Alternative | The job title of the employee. |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | The last name of the employee. |
last_name (anyOf 2) | null | Alternative | The last name of the employee. |
middle_name | JSON | Optional | |
middle_name (anyOf 1) | string | Alternative | The middle name of the employee. |
middle_name (anyOf 2) | null | Alternative | The middle name of the employee. |
nationalities | array | Optional | The nationality of the employee. |
nationalities[] | string | Each item | |
new_hiring_status | JSON | Optional | |
new_hiring_status (anyOf 1) | string | Alternative | The new hiring status of the employee. |
new_hiring_status (anyOf 2) | null | Alternative | The new hiring status of the employee. |
person_status | JSON | Optional | Lifecycle status of the person (worker profile). Omitted or null without people_person_status.view; excluded from the response when using `fields` if not requested. |
person_status (anyOf 1) | string | Alternative | Lifecycle status of the person (worker profile). Omitted or null without people_person_status.view; excluded from the response when using `fields` if not requested. Known values: ACTIVE, NOT_STARTED, INACTIVE |
person_status (anyOf 2) | null | Alternative | |
preferred_first_name | JSON | Optional | |
preferred_first_name (anyOf 1) | string | Alternative | The preferred first name of the employee. |
preferred_first_name (anyOf 2) | null | Alternative | The preferred first name of the employee. |
preferred_last_name | JSON | Optional | |
preferred_last_name (anyOf 1) | string | Alternative | The preferred last name of the employee. |
preferred_last_name (anyOf 2) | null | Alternative | The preferred last name of the employee. |
seniority | JSON | Optional | |
seniority (anyOf 1) | string | Alternative | The seniority level of the employee. |
seniority (anyOf 2) | null | Alternative | The seniority level of the employee. |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The date the employee started working. Format: date |
start_date (anyOf 2) | null | Alternative | The date the employee started working. Format: date |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | The state of the employee. |
state (anyOf 2) | null | Alternative | The state of the employee. |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | The timezone of the employee. |
timezone (anyOf 2) | null | Alternative | The timezone of the employee. |
updated_at | JSON | Optional | |
updated_at (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
updated_at (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
work_location | JSON | Optional | |
work_location (anyOf 1) | string | Alternative | The work location of the employee. |
work_location (anyOf 2) | null | Alternative | The work location of the employee. |
worker_id | string | Optional | The worker ID of the employee. |
Referenced models: Retrieve a single person — 200 response body — data additional details null item, List of People — 200 response body — data item addresses null item, Retrieve a single person — 200 response body — data client legal entity, List of People — 200 response body — data item department, List of People — 200 response body — data item direct manager The direct manager of the employee, List of People — 200 response body — data item direct reports The direct reports to the employee item, List of People — 200 response body — data item emails An array of the employee's email addresses item, List of People — 200 response body — data item employments null item
List of People — 200 response body — data item addresses null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
country (anyOf 2) | null | Alternative | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
lineTwo | string | Optional | Second address line. |
locality | string | Optional | Locality name. |
postalCode | string | Optional | Postal code. |
region | string | Optional | Region code. |
streetAddress | string | Optional | Street and number. |
List of People — 200 response body — data item department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The department of the employee. |
id | string | Optional | Unique identifier of this resource. Format: uuid |
name | string | Optional | The name of the department. |
parent | string | Optional | The parent department name. |
List of People — 200 response body — data item direct manager The direct manager of the employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The direct manager of the employee. |
first_name | string | Optional | The first name of the manager. |
id | string | Optional | Unique identifier for the manager. |
last_name | string | Optional | The last name of the manager. |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email of the manager. |
work_email (anyOf 2) | null | Alternative | The work email of the manager. |
worker_id | JSON | Optional | |
worker_id (anyOf 1) | number | Alternative | The worker ID of the manager. Format: double |
worker_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List of People — 200 response body — data item direct reports The direct reports to the employee item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
first_name | string | Optional | The first name of the direct report. |
id | string | Optional | Unique identifier for the direct report. |
last_name | string | Optional | The last name of the direct report. |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email of the direct report. |
work_email (anyOf 2) | null | Alternative | The work email of the direct report. |
List of People — 200 response body — data item emails An array of the employee's email addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The type of email. |
type (anyOf 2) | null | Alternative | The type of email. |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The email address. |
value (anyOf 2) | null | Alternative | The email address. |
List of People — 200 response body — data item employments null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
band_placement | JSON | Optional | Where the employee falls in their compensation band |
band_placement (anyOf 1) | string | Alternative | Where the employee falls in their compensation band Known values: ABOVE, WITHIN, BELOW |
band_placement (anyOf 2) | null | Alternative | |
client_legal_entity | Model | Optional | Expand Retrieve a single person — 200 response body — data employments item client legal entity id, name The client legal entity associated with this employment contract. |
comparative_ratio | JSON | Optional | |
comparative_ratio (anyOf 1) | JSON | Alternative | |
comparative_ratio (anyOf 1) (anyOf 1) | number | Alternative | Number comparing an employee's compensation to the band midpoint Format: double |
comparative_ratio (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comparative_ratio (anyOf 2) | null | Alternative | Number comparing an employee's compensation to the band midpoint Format: double |
compensation_band_id | JSON | Optional | |
compensation_band_id (anyOf 1) | string | Alternative | The employee's assigned compensation band |
compensation_band_id (anyOf 2) | null | Alternative | The employee's assigned compensation band |
completion_date | JSON | Optional | |
completion_date (anyOf 1) | string | Alternative | The completion date of the employment contract. |
completion_date (anyOf 2) | null | Alternative | The completion date of the employment contract. |
contract_coverage | JSON | Optional | The coverage of the employment contract. |
contract_coverage (anyOf 1) | string | Alternative | The coverage of the employment contract. Known values: is_premium, is_shielded, no_coverage |
contract_coverage (anyOf 2) | null | Alternative | |
contract_has_contractor | boolean | Optional | Whether the contract has a contractor. |
contract_is_archived | boolean | Optional | Whether the employment contract is archived. |
contract_status | string | Optional | The status of the employment contract. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The country of employment. |
country (anyOf 2) | null | Alternative | The country of employment. |
email | string | Optional | The work email of the employee. |
has_eor_termination | JSON | Optional | |
has_eor_termination (anyOf 1) | boolean | Alternative | Whether the employment has an EOR termination. |
has_eor_termination (anyOf 2) | null | Alternative | Whether the employment has an EOR termination. |
hiring_status | string | Optional | The current hiring status of the employment. |
hiring_type | JSON | Optional | |
hiring_type (anyOf 1) | string | Alternative | The type of hiring of the employment. |
hiring_type (anyOf 2) | null | Alternative | The type of hiring of the employment. |
hris_direct_employee_invitation | JSON | Optional | The HRIS direct employee invitation status. |
hris_direct_employee_invitation (anyOf 1) | Model | Alternative | Expand Retrieve a single person — 200 response body — data employments item hris direct employee invitation The HRIS direct employee invitation status |
hris_direct_employee_invitation (anyOf 2) | null | Alternative | |
id | string | Optional | Unique identifier for the employment. |
is_ended | boolean | Optional | Whether the employment has ended. |
is_user_contract_deleted | boolean | Optional | Whether the user contract is deleted. |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | The job title of the employment. |
job_title (anyOf 2) | null | Alternative | The job title of the employment. |
name | string | Optional | Name of the employee. |
new_hiring_status | JSON | Optional | |
new_hiring_status (anyOf 1) | string | Alternative | The new hiring status of the employment. |
new_hiring_status (anyOf 2) | null | Alternative | The new hiring status of the employment. |
payment | Model | Optional | Expand List of People — 200 response body — data item employments null item payment Payment information for the employment, including rate, scale, currency, and associated contract name. |
seniority | JSON | Optional | |
seniority (anyOf 1) | string | Alternative | The seniority level of the employment. |
seniority (anyOf 2) | null | Alternative | The seniority level of the employment. |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The start date of the employment. Format: date |
start_date (anyOf 2) | null | Alternative | The start date of the employment. Format: date |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | The state of employment. |
state (anyOf 2) | null | Alternative | The state of employment. |
team | Model | Optional | Expand Retrieve a single person — 200 response body — data employments item team The team to which the employee belongs. |
termination_last_day | JSON | Optional | |
termination_last_day (anyOf 1) | string | Alternative | The last day of work mentioned on the contract termination. Format: date-time |
termination_last_day (anyOf 2) | null | Alternative | The last day of work mentioned on the contract termination. Format: date-time |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | The timezone of the employment. |
timezone (anyOf 2) | null | Alternative | The timezone of the employment. |
voluntarily_left | JSON | Optional | |
voluntarily_left (anyOf 1) | boolean | Alternative | Whether the employee voluntarily left the employment. |
voluntarily_left (anyOf 2) | null | Alternative | Whether the employee voluntarily left the employment. |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email of the employment. |
work_email (anyOf 2) | null | Alternative | The work email of the employment. |
Referenced models: Retrieve a single person — 200 response body — data employments item client legal entity id, name, Retrieve a single person — 200 response body — data employments item hris direct employee invitation The HRIS direct employee invitation status, List of People — 200 response body — data item employments null item payment, Retrieve a single person — 200 response body — data employments item team
List of People — 200 response body — data item employments null item payment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment information for the employment, including rate, scale, currency, and associated contract name. |
contract_name | string | Optional | The name of the contract associated with the payment |
currency | string | Optional | The currency code (ISO 4217) for the payment |
rate | JSON | Optional | |
rate (anyOf 1) | string | Alternative | The payment rate |
rate (anyOf 2) | null | Alternative | The payment rate |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | The payment scale (e.g., hourly, weekly, monthly, etc.) |
scale (anyOf 2) | null | Alternative | The payment scale (e.g., hourly, weekly, monthly, etc.) |
List of People — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items_per_page | JSON | Required within parent | |
items_per_page (anyOf 1) | number | Alternative | Format: double Maximum: 200 Minimum: 1 |
items_per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
offset | JSON | Required within parent | |
offset (anyOf 1) | integer | Alternative | Maximum: 999999999 Minimum: 0 |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | number | Alternative | Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List of People — request body — query fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | One of: id, created_at, first_name, last_name, full_name, preferred_first_name, preferred_last_name, worker_id, external_id, hris_organization_user_id, termination_last_day, worker_relations, custom_field_values, emails, birth_date, start_date, nationalities, client_legal_entity, state, seniority, completion_date, direct_manager, direct_reports, direct_reports_count, employments, employments[0].id, employments[0].name, employments[0].team, employments[0].custom_field_values, employments[0].email, employments[0].state, employments[0].country, employments[0].payment, employments[0].is_ended, employments[0].termination_last_day, employments[0].timezone, employments[0].job_title, employments[0].seniority, employments[0].start_date, employments[0].work_email, employments[0].hiring_type, employments[0].hiring_status, employments[0].completion_date, employments[0].contract_status, employments[0].voluntarily_left, employments[0].contract_coverage, employments[0].new_hiring_status, employments[0].client_legal_entity, employments[0].has_eor_termination, employments[0].contract_is_archived, employments[0].contract_has_contractor, employments[0].is_user_contract_deleted, employments[0].hris_direct_employee_invitation, employments[0].employee_number, hiring_status, new_hiring_status, is_pwac, hiring_type, job_title, country, timezone, department, work_location, updated_at, addresses, additional_details, profile_organizational_structures, worker_termination_last_date_of_work, active_worker_termination_status, last_day_of_work_local_date, person_status |
List worker addresses — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Addresses of the worker. |
data[] | Model | Each item | Expand List worker addresses — 200 response body — data item |
Referenced models: List worker addresses — 200 response body — data item
List worker addresses — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | The city. |
city (anyOf 2) | null | Alternative | The city. |
contract_id | JSON | Required within parent | |
contract_id (anyOf 1) | string | Alternative | Contract the address belongs to; null for HOME and POSTAL addresses. |
contract_id (anyOf 2) | null | Alternative | Contract the address belongs to; null for HOME and POSTAL addresses. |
country | string | Required within parent | The two-letter country code. |
effective_date | JSON | Required within parent | |
effective_date (anyOf 1) | string | Alternative | Date (YYYY-MM-DD) from which this version of the address applies. Format: date |
effective_date (anyOf 2) | null | Alternative | Date (YYYY-MM-DD) from which this version of the address applies. Format: date |
id | string | Required within parent | Unique identifier of the address, shared by its current and scheduled versions. Format: uuid |
line_two | JSON | Required within parent | |
line_two (anyOf 1) | string | Alternative | The second address line. |
line_two (anyOf 2) | null | Alternative | The second address line. |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | The state. |
state (anyOf 2) | null | Alternative | The state. |
street | JSON | Required within parent | |
street (anyOf 1) | string | Alternative | The street address. |
street (anyOf 2) | null | Alternative | The street address. |
type | string | Required within parent | The type of the address. Contract addresses are read-only on this API. Known values: HOME, POSTAL, CONTRACT |
zip | JSON | Required within parent | |
zip (anyOf 1) | string | Alternative | The zip code. |
zip (anyOf 2) | null | Alternative | The zip code. |
Retrieve a single person — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a single person — 200 response body — data |
Referenced models: Retrieve a single person — 200 response body — data
Retrieve a single person — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active_worker_termination_status | JSON | Optional | The status of the active worker termination. |
active_worker_termination_status (anyOf 1) | string | Alternative | The status of the active worker termination. Known values: PENDING, CONTRACT_TERMINATION_DATA_COLLECTED, IN_PROGRESS, COMPLETED, FAILED, CANCELED |
active_worker_termination_status (anyOf 2) | null | Alternative | |
additional_details | JSON | Optional | |
additional_details (anyOf 1) | array | Alternative | Country-scoped additional employment data points (national IDs, tax IDs, etc.) sourced from hris_employment_eligibility.eligibility_data. Returned only when the caller's organization has the feature flag enabled and the request is not redacting PII. |
additional_details (anyOf 1)[] | Model | Each item | Expand Retrieve a single person — 200 response body — data additional details null item |
additional_details (anyOf 2) | null | Alternative | Country-scoped additional employment data points (national IDs, tax IDs, etc.) sourced from hris_employment_eligibility.eligibility_data. Returned only when the caller's organization has the feature flag enabled and the request is not redacting PII. |
additional_details (anyOf 2)[] | Model | Each item | Expand Retrieve a single person — 200 response body — data additional details null item |
addresses | array | Optional | An array of address objects containing the employee's physical addresses. |
addresses[] | Model | Each item | Expand Retrieve a single person — 200 response body — data addresses item |
birth_date | JSON | Optional | |
birth_date (anyOf 1) | string | Alternative | The birth date of the employee. |
birth_date (anyOf 2) | null | Alternative | The birth date of the employee. |
client_legal_entity | Model | Optional | Expand Retrieve a single person — 200 response body — data client legal entity The primary client legal entity associated with the employee. |
completion_date | JSON | Optional | |
completion_date (anyOf 1) | string | Alternative | The completion date of the task or project. |
completion_date (anyOf 2) | null | Alternative | The completion date of the task or project. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The country of the employee. |
country (anyOf 2) | null | Alternative | The country of the employee. |
created_at | string | Optional | The creation timestamp of the employee record. Format: date-time |
custom_fields | array | Optional | An array of custom field objects containing additional attributes associated with the employee (e.g., Job title, Project code, etc.). |
custom_fields[] | Model | Each item | Expand Retrieve a single person — 200 response body — data custom fields item |
department | Model | Optional | Expand Retrieve a single person — 200 response body — data department The department of the employee. |
direct_employee_termination_last_day | string | Optional | The last day of work mentioned on the primary contract termination. Format: date |
direct_manager | JSON | Optional | The direct manager of the employee. |
direct_manager (anyOf 1) | Model | Alternative | Expand Retrieve a single person — 200 response body — data direct manager The direct manager of the employee |
direct_manager (anyOf 2) | null | Alternative | |
direct_reports | JSON | Optional | |
direct_reports (anyOf 1) | array | Alternative | The direct reports to the employee. |
direct_reports (anyOf 1)[] | Model | Each item | Expand Retrieve a single person — 200 response body — data direct reports The direct reports to the employee item |
direct_reports (anyOf 2) | null | Alternative | The direct reports to the employee. |
direct_reports (anyOf 2)[] | Model | Each item | Expand Retrieve a single person — 200 response body — data direct reports The direct reports to the employee item |
direct_reports_count | JSON | Optional | |
direct_reports_count (anyOf 1) | integer | Alternative | The count of direct reports to the employee. |
direct_reports_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
emails | array | Optional | An array of the employee's email addresses. |
emails[] | Model | Each item | Expand Retrieve a single person — 200 response body — data emails item |
employments | array | Optional | An array of employment records associated with the employee, including contract details, team information, payment details, and employment status. |
employments[] | Model | Each item | Expand Retrieve a single person — 200 response body — data employments item |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | The external ID of the employee. |
external_id (anyOf 2) | null | Alternative | The external ID of the employee. |
first_name | string | Optional | The first name of the employee. |
full_name | string | Optional | The full name of the employee. |
hiring_status | string | Optional | The current hiring status of the employee. |
hiring_type | string | Optional | The type of hiring of the employee. |
id | string | Optional | Unique identifier for the employee. Format: uuid |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | The job title of the employee. |
job_title (anyOf 2) | null | Alternative | The job title of the employee. |
last_name | string | Optional | The last name of the employee. |
nationalities | array | Optional | The nationality of the employee. |
nationalities[] | string | Each item | |
new_hiring_status | string | Optional | The new hiring status of the employee. |
preferred_first_name | JSON | Optional | |
preferred_first_name (anyOf 1) | string | Alternative | The preferred first name of the employee. |
preferred_first_name (anyOf 2) | null | Alternative | The preferred first name of the employee. |
preferred_last_name | JSON | Optional | |
preferred_last_name (anyOf 1) | string | Alternative | The preferred last name of the employee. |
preferred_last_name (anyOf 2) | null | Alternative | The preferred last name of the employee. |
profile_organizational_structures | array | Optional | An array of organizational structures associated with the employee profile. |
profile_organizational_structures[] | Model | Each item | Expand Retrieve a single person — 200 response body — data profile organizational structures item |
seniority | JSON | Optional | |
seniority (anyOf 1) | string | Alternative | The seniority level of the employee. |
seniority (anyOf 2) | null | Alternative | The seniority level of the employee. |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The date the employee started working. Format: date |
start_date (anyOf 2) | null | Alternative | The date the employee started working. Format: date |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | The state of the employee. |
state (anyOf 2) | null | Alternative | The state of the employee. |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | The timezone of the employee. |
timezone (anyOf 2) | null | Alternative | The timezone of the employee. |
updated_at | JSON | Optional | |
updated_at (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
updated_at (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
work_location | JSON | Optional | |
work_location (anyOf 1) | string | Alternative | The work location of the employee. |
work_location (anyOf 2) | null | Alternative | The work location of the employee. |
worker_id | string | Optional | The worker ID of the employee. |
Referenced models: Retrieve a single person — 200 response body — data additional details null item, Retrieve a single person — 200 response body — data client legal entity, Retrieve a single person — 200 response body — data addresses item, Retrieve a single person — 200 response body — data custom fields item, Retrieve a single person — 200 response body — data department, Retrieve a single person — 200 response body — data direct manager The direct manager of the employee, Retrieve a single person — 200 response body — data direct reports The direct reports to the employee item, Retrieve a single person — 200 response body — data emails item, Retrieve a single person — 200 response body — data employments item, Retrieve a single person — 200 response body — data profile organizational structures item
Retrieve a single person — 200 response body — data additional details null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Optional | ISO-2 country code that scopes this entry. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
type | string | Optional | Field name (the JSONB key from hris_employment_eligibility.eligibility_data, e.g. socialSecurity, idNumber, taxIdentificationNumber). |
value | Model | Optional | Expand Retrieve a single person — 200 response body — data additional details null item value Raw value associated with the field. May be a string, number, boolean, or null. |
Referenced models: Retrieve a single person — 200 response body — data additional details null item value
Retrieve a single person — 200 response body — data additional details null item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Raw value associated with the field. May be a string, number, boolean, or null. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3) | boolean | Alternative | |
$ (anyOf 4) | object | Alternative | Additional keys: see wildcard field |
$ (anyOf 4).* | JSON | Additional keys | Any type |
Retrieve a single person — 200 response body — data addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Optional | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
locality | string | Optional | Locality name. |
postalCode | string | Optional | Postal code. |
region | string | Optional | Region code. |
streetAddress | string | Optional | Street and number. |
Retrieve a single person — 200 response body — data client legal entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The primary client legal entity associated with the employee. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier of this resource. Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier of this resource. Format: uuid |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the client legal entity. |
name (anyOf 2) | null | Alternative | The name of the client legal entity. |
Retrieve a single person — 200 response body — data custom fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Customized attributes on people (Job title, Project code, etc). |
name | string | Optional | Custom field property name. |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | Custom field property value. |
value (anyOf 2) | null | Alternative | Custom field property value. |
Retrieve a single person — 200 response body — data department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The department of the employee. |
id | string | Optional | Unique identifier of this resource. Format: uuid |
name | string | Optional | The name of the department. |
parent | string | Optional | The parent department. |
Retrieve a single person — 200 response body — data direct manager The direct manager of the employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The direct manager of the employee. |
first_name | string | Optional | The first name of the manager. |
id | string | Optional | Unique identifier for the manager. Format: uuid |
last_name | string | Optional | The last name of the manager. |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email of the manager. |
work_email (anyOf 2) | null | Alternative | The work email of the manager. |
worker_id | JSON | Optional | |
worker_id (anyOf 1) | number | Alternative | The worker ID of the manager. Format: double |
worker_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a single person — 200 response body — data direct reports The direct reports to the employee item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
first_name | string | Optional | The first name of the direct report. |
id | string | Optional | Unique identifier for the direct report. Format: uuid |
last_name | string | Optional | The last name of the direct report. |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email of the direct report. |
work_email (anyOf 2) | null | Alternative | The work email of the direct report. |
Retrieve a single person — 200 response body — data emails item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | The type of email. |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The email address. |
value (anyOf 2) | null | Alternative | The email address. |
Retrieve a single person — 200 response body — data employments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_legal_entity | JSON | Optional | The client legal entity associated with this employment contract. |
client_legal_entity (anyOf 1) | Model | Alternative | Expand Retrieve a single person — 200 response body — data employments item client legal entity id, name |
client_legal_entity (anyOf 2) | null | Alternative | |
completion_date | JSON | Optional | |
completion_date (anyOf 1) | string | Alternative | The completion date of the employment contract. |
completion_date (anyOf 2) | null | Alternative | The completion date of the employment contract. |
contract_coverage | JSON | Optional | The coverage type of the employment contract. 'is_shielded' = Contractor of Record, 'is_premium' = Premium, null = Standard (no coverage). |
contract_coverage (anyOf 1) | string | Alternative | The coverage type of the employment contract. 'is_shielded' = Contractor of Record, 'is_premium' = Premium, null = Standard (no coverage). Known values: is_shielded, is_premium |
contract_coverage (anyOf 2) | null | Alternative | |
contract_has_contractor | boolean | Optional | Whether the contract has a contractor. |
contract_is_archived | boolean | Optional | Whether the employment contract is archived. |
contract_status | string | Optional | The status of the employment contract. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The country of employment. |
country (anyOf 2) | null | Alternative | The country of employment. |
email | string | Optional | The work email of the employee. |
has_eor_termination | JSON | Optional | |
has_eor_termination (anyOf 1) | boolean | Alternative | Whether the employment has an EOR termination. |
has_eor_termination (anyOf 2) | null | Alternative | Whether the employment has an EOR termination. |
hiring_status | string | Optional | The current hiring status of the employment. |
hiring_type | string | Optional | The type of hiring of the employment. |
hris_direct_employee_invitation | JSON | Optional | The HRIS direct employee invitation status. |
hris_direct_employee_invitation (anyOf 1) | Model | Alternative | Expand Retrieve a single person — 200 response body — data employments item hris direct employee invitation The HRIS direct employee invitation status |
hris_direct_employee_invitation (anyOf 2) | null | Alternative | |
id | string | Optional | Unique identifier for the employment. |
is_ended | boolean | Optional | Whether the employment has ended. |
is_user_contract_deleted | boolean | Optional | Whether the user contract is deleted. |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | The job title of the employment. |
job_title (anyOf 2) | null | Alternative | The job title of the employment. |
name | string | Optional | Name of the employee. |
new_hiring_status | string | Optional | The new hiring status of the employment. |
payment | Model | Optional | Expand Retrieve a single person — 200 response body — data employments item payment Payment information for the employment, including rate, scale, currency, and associated contract name. |
seniority | JSON | Optional | |
seniority (anyOf 1) | string | Alternative | The seniority level of the employment. |
seniority (anyOf 2) | null | Alternative | The seniority level of the employment. |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The start date of the employment. Format: date |
start_date (anyOf 2) | null | Alternative | The start date of the employment. Format: date |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | The state of employment. |
state (anyOf 2) | null | Alternative | The state of employment. |
team | Model | Optional | Expand Retrieve a single person — 200 response body — data employments item team The team to which the employee belongs. |
termination_last_day | JSON | Optional | |
termination_last_day (anyOf 1) | string | Alternative | The last day of work mentioned on the contract termination. Format: date-time |
termination_last_day (anyOf 2) | null | Alternative | The last day of work mentioned on the contract termination. Format: date-time |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | The timezone of the employment. |
timezone (anyOf 2) | null | Alternative | The timezone of the employment. |
voluntarily_left | JSON | Optional | |
voluntarily_left (anyOf 1) | boolean | Alternative | Whether the employee voluntarily left the employment. |
voluntarily_left (anyOf 2) | null | Alternative | Whether the employee voluntarily left the employment. |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email of the employment. |
work_email (anyOf 2) | null | Alternative | The work email of the employment. |
Referenced models: Retrieve a single person — 200 response body — data employments item client legal entity id, name, Retrieve a single person — 200 response body — data employments item hris direct employee invitation The HRIS direct employee invitation status, Retrieve a single person — 200 response body — data employments item team, Retrieve a single person — 200 response body — data employments item payment
Retrieve a single person — 200 response body — data employments item client legal entity id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The client legal entity associated with this employment contract. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier of this resource. Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier of this resource. Format: uuid |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the client legal entity. |
name (anyOf 2) | null | Alternative | The name of the client legal entity. |
Retrieve a single person — 200 response body — data employments item hris direct employee invitation The HRIS direct employee invitation status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The HRIS direct employee invitation status. |
oid | string | Optional | Unique identifier of this resource. |
send_at | JSON | Optional | |
send_at (anyOf 1) | string | Alternative | The HRIS direct employee invitation send date. Format: date-time |
send_at (anyOf 2) | null | Alternative | The HRIS direct employee invitation send date. Format: date-time |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | The HRIS direct employee invitation status. |
status (anyOf 2) | null | Alternative | The HRIS direct employee invitation status. |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | The HRIS direct employee invitation timezone. |
timezone (anyOf 2) | null | Alternative | The HRIS direct employee invitation timezone. |
Retrieve a single person — 200 response body — data employments item payment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment information for the employment, including rate, scale, currency, and associated contract name. |
contract_name | string | Optional | The name of the contract associated with the payment |
currency | string | Optional | The currency code (ISO 4217) for the payment |
rate | Model | Optional | Expand Retrieve a single person — 200 response body — data employments item payment rate The payment rate. Value is a string if contract type is PEO. |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | The payment scale (e.g., hourly, weekly, monthly, etc.) |
scale (anyOf 2) | null | Alternative | The payment scale (e.g., hourly, weekly, monthly, etc.) |
Referenced models: Retrieve a single person — 200 response body — data employments item payment rate
Retrieve a single person — 200 response body — data employments item payment rate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The payment rate. Value is a string if contract type is PEO. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a single person — 200 response body — data employments item team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The team to which the employee belongs. |
id | string | Optional | Refers to Groups in the platform. Working groups that reflect the organization's structure. Format: uuid |
name | string | Optional | The team name. |
Retrieve a single person — 200 response body — data profile organizational structures item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Id of the Organizational structure. Format: uuid |
name | string | Optional | Name of the Organizational structure. |
teams | array | Optional | List of teams in the organizational structure. |
teams[] | Model | Each item | Expand Retrieve a single person — 200 response body — data profile organizational structures item teams item |
Referenced models: Retrieve a single person — 200 response body — data profile organizational structures item teams item
Retrieve a single person — 200 response body — data profile organizational structures item teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Id of the team. Format: uuid |
name | string | Optional | Name of the team. |
name_hierarchy | JSON | Optional | |
name_hierarchy (anyOf 1) | string | Alternative | Hierarchy of the team. |
name_hierarchy (anyOf 2) | null | Alternative | Hierarchy of the team. |
positions | array | Optional | An array of positions held by the employee within this team. |
positions[] | Model | Each item | Expand Retrieve a single person — 200 response body — data profile organizational structures item teams item positions item |
Referenced models: Retrieve a single person — 200 response body — data profile organizational structures item teams item positions item
Retrieve a single person — 200 response body — data profile organizational structures item teams item positions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Id of the position. Format: uuid |
is_supportive | boolean | Optional | Whether the position is supportive or not. |
role | JSON | Optional | The role associated with this position, including role ID and name. |
role (anyOf 1) | Model | Alternative | Expand Retrieve a single person — 200 response body — data profile organizational structures item teams item positions item role id, name |
role (anyOf 2) | null | Alternative |
Referenced models: Retrieve a single person — 200 response body — data profile organizational structures item teams item positions item role id, name
Retrieve a single person — 200 response body — data profile organizational structures item teams item positions item role id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The role associated with this position, including role ID and name. |
id | string | Optional | Id of the role. Format: uuid |
name | string | Optional | Name of the role. |
Update worker address by type — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update worker address by type — 200 response body — data The address version written by the request. |
Referenced models: Update worker address by type — 200 response body — data
Update worker address by type — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The address version written by the request. |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | The city. |
city (anyOf 2) | null | Alternative | The city. |
country | string | Required within parent | The two-letter country code. |
effective_date | JSON | Required within parent | |
effective_date (anyOf 1) | string | Alternative | Date (YYYY-MM-DD) from which this version of the address applies. Format: date |
effective_date (anyOf 2) | null | Alternative | Date (YYYY-MM-DD) from which this version of the address applies. Format: date |
id | string | Required within parent | Unique identifier of the address. Format: uuid |
line_two | JSON | Required within parent | |
line_two (anyOf 1) | string | Alternative | The second address line. |
line_two (anyOf 2) | null | Alternative | The second address line. |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | The state. |
state (anyOf 2) | null | Alternative | The state. |
street | JSON | Required within parent | |
street (anyOf 1) | string | Alternative | The street address. |
street (anyOf 2) | null | Alternative | The street address. |
type | string | Required within parent | The type of the address. Known values: HOME, POSTAL |
zip | JSON | Required within parent | |
zip (anyOf 1) | string | Alternative | The zip code. |
zip (anyOf 2) | null | Alternative | The zip code. |
Update worker address by type — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Address fields to change, with optional effective date and edit reason. |
city | string or null | Optional | The city. |
country | string | Optional | The two-letter country code. Required when the address is created; cannot be null. |
edit_reason | JSON | Optional | Reason recorded with the change. |
edit_reason (oneOf 1) | Model | Alternative | Expand Update worker address by type — request body — body data edit reason Reason recorded with the change |
edit_reason (oneOf 2) | null | Alternative | |
effective_date | string | Optional | Date (YYYY-MM-DD) from which the change applies; a future date schedules it. Format: date |
line_two | string or null | Optional | The second address line. |
state | string or null | Optional | The state. |
street | string or null | Optional | The street address. |
zip | string or null | Optional | The zip code. |
Referenced models: Update worker address by type — request body — body data edit reason Reason recorded with the change
Update worker address by type — request body — body data edit reason Reason recorded with the change
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reason recorded with the change. |
additional_info | string or null | Optional | Free-text details about the change. Maximum length: 2000 |
reason_oid | string | Optional | Public id of the edit reason. Format: uuid |
Update working location — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update working location — 200 response body — data |
Referenced models: Update working location — 200 response body — data
Update working location — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
updated | boolean | Required within parent | Indicates if the resource was updated successfully. |
Update working location — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
working_location_id | number | Required within parent | Unique identifier of this resource. Format: double |