Skip to content

Deel: People schemas

69 Deel schemas with complete fields and constraints.

← People operations · All schemas

Create a direct employee — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
compensation_detailsModelRequired within parentExpand Create a direct employee — 201 response body — data compensation details
The compensation details of the employee
employeeModelRequired within parentExpand Create a direct employee — 201 response body — data employee
The person that is being hired
employmentModelRequired within parentExpand Create a direct employee — 201 response body — data employment
The employment details of the employee
idstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootThe compensation details of the employee
currencystringRequired within parentThe currency of the salary
Maximum length: 3
Minimum length: 3
salarystringRequired within parentThe salary of the employee
scalestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThe person that is being hired
emailstringRequired within parentThe personal email of the person being hired
Format: email
Maximum length: 255
Minimum length: 3
external_idstringOptionalAn external identifier for the person being hired
first_namestringRequired within parentThe first name of the person being hired
Maximum length: 100
Minimum length: 3
last_namestringRequired within parentThe last name of the person being hired
Maximum length: 100
Minimum length: 3
nationalitystringRequired within parentThe nationality of the person being hired
Maximum length: 2
Minimum length: 2
work_emailstringOptionalThe work email of the person being hired
Format: email
Maximum length: 255
Minimum length: 3

Create a direct employee — 201 response body — data employment

FieldTypePresenceDescription and constraints
$objectRootThe employment details of the employee
contract_idstringRequired within parentThe unique identifier of the worker contract
countrystringRequired within parentThe country of the employment
Maximum length: 2
Minimum length: 2
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeThe end date of the employment. `null` for open-ended employments.
Format: date
end_date (anyOf 2)nullAlternativeThe end date of the employment. `null` for open-ended employments.
Format: date
job_titlestringRequired within parentThe job title of the employment
part_time_percentageJSONOptional
part_time_percentage (anyOf 1)numberAlternativeThe percentage of PART_TIME employment
Format: double
Maximum: 99
Minimum: 1
part_time_percentage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
senioritystringRequired within parentThe seniority of the employment
start_datestringRequired within parentThe start date of the employment
Format: date
typestringRequired within parentThe type of employment
Known values: FULL_TIME, PART_TIME

Create a direct employee — request body — body / data / employment / type: FULL TIME

FieldTypePresenceDescription and constraints
$objectRoot
document_template_idstringOptionalThe document template ID for the employment contract
Format: uuid
end_datestringOptionalThe end date of the employment
Format: date
job_titlestringRequired within parentThe job title of the employment
senioritystringRequired within parentThe seniority of the employment
start_datestringRequired within parentThe start date of the employment
Format: date
typestringRequired within parentThe type of employment
One of: FULL_TIME

Create a direct employee — request body — body / data / employment / type: PART TIME

FieldTypePresenceDescription and constraints
$objectRoot
document_template_idstringOptionalThe document template ID for the employment contract
Format: uuid
end_datestringOptionalThe end date of the employment
Format: date
job_titlestringRequired within parentThe job title of the employment
part_time_percentagenumberRequired within parentThe percentage of PART_TIME employment
Format: double
Maximum: 99
Minimum: 1
senioritystringRequired within parentThe seniority of the employment
start_datestringRequired within parentThe start date of the employment
Format: date
typestringRequired within parentThe type of employment
One of: PART_TIME

Create a direct employee — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
clientModelRequired within parentExpand Create a direct employee — request body — body data client
The entity that is hiring the employee
compensation_detailsModelRequired within parentExpand Create a direct employee — request body — body data compensation details
The compensation details of the employee
employeeModelRequired within parentExpand Create a direct employee — request body — body data employee
The person that is being hired
employmentModelRequired within parentExpand Create a direct employee — request body — body data employment
The employment details of the employee
invitationModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe entity that is hiring the employee
departmentModelOptionalExpand Create a direct employee — request body — body data client department
The department information for the employee
legal_entityModelRequired within parentExpand Create a direct employee — request body — body data client legal entity
The legal entity information for the employee
teamModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe department information for the employee
idstringRequired within parentThe department that the employee is part of
Format: uuid

Create a direct employee — request body — body data client legal entity

FieldTypePresenceDescription and constraints
$objectRootThe legal entity information for the employee
idstringRequired within parentThe legal entity that the employee is part of
Format: uuid

Create a direct employee — request body — body data client team

FieldTypePresenceDescription and constraints
$objectRootThe team information for the employee
direct_manager_idstringOptionalThe direct manager of the employee
Format: uuid
idstringRequired within parentThe team that the employee is part of
Format: uuid

Create a direct employee — request body — body data compensation details

FieldTypePresenceDescription and constraints
$objectRootThe compensation details of the employee
currencystringRequired within parentThe currency of the salary
Maximum length: 3
Minimum length: 3
salarystringRequired within parentThe salary of the employee
scalestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThe person that is being hired
countrystringRequired within parentThe country of the person being hired
Maximum length: 2
Minimum length: 2
emailstringRequired within parentThe personal email of the person being hired
Format: email
Maximum length: 255
Minimum length: 3
external_idstringOptionalAn external identifier for the person being hired
first_namestringRequired within parentThe first name of the person being hired
Maximum length: 100
Minimum length: 3
last_namestringRequired within parentThe last name of the person being hired
Maximum length: 100
Minimum length: 3
nationalitystringRequired within parentThe nationality of the person being hired
Maximum length: 2
Minimum length: 2
statestringOptionalThe state of the person being hired
Maximum length: 50
Minimum length: 1
work_emailstringOptionalThe work email of the person being hired
Format: email
Maximum length: 255
Minimum length: 3

Create a direct employee — request body — body data employment

FieldTypePresenceDescription and constraints
$JSONRootThe employment details of the employee
$ (oneOf 1)ModelAlternativeExpand Create a direct employee — request body — body / data / employment / type: PART TIME
$ (oneOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootOptional invitation configuration for the new hire. Defaults to 'IMMEDIATE' if not provided.
actionstringOptionalControls whether to send an invitation email.
One of: DISABLE, IMMEDIATE

Create a person without a contract — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe id of the person
Format: uuid
personModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe person that is being hired
countrystringOptionalThe country of the person being hired
Maximum length: 2
Minimum length: 2
emailstringRequired within parentThe personal email of the person being hired
Format: email
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe end date of the person being hired
Format: date
end_date (anyOf 2)nullAlternativeThe end date of the person being hired
Format: date
external_idJSONOptional
external_id (anyOf 1)stringAlternativeAn external identifier for the person being hired
external_id (anyOf 2)nullAlternativeAn external identifier for the person being hired
first_namestringRequired within parentThe first name of the person being hired
job_titlestringOptionalThe job title of the person being hired
last_namestringRequired within parentThe last name of the person being hired
nationalitystringOptionalThe nationality of the person being hired
Maximum length: 2
Minimum length: 2
senioritystringOptionalThe seniority of the person being hired
start_datestringRequired within parentThe start date of the person being hired
Format: date
statestringOptionalThe state of the person being hired
Maximum length: 50
Minimum length: 1
work_emailstringOptionalThe work email of the person being hired
Format: email
worker_idJSONOptional
worker_id (anyOf 1)numberAlternativeThe worker ID of the person being hired
Format: double
worker_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a person without a contract — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
clientModelRequired within parentExpand Create a person without a contract — request body — body data client
invitationModelOptionalExpand Create a person without a contract — request body — body data invitation
Optional invitation configuration for the new hire. Defaults to 'disable' if not provided.
personModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
departmentModelOptionalExpand Create a person without a contract — request body — body data client department
legal_entityModelRequired within parentExpand Create a person without a contract — request body — body data client legal entity
teamModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe department that the person is part of
Format: uuid

Create a person without a contract — request body — body data client legal entity

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe legal entity that the person is part of
Format: uuid

Create a person without a contract — request body — body data client team

FieldTypePresenceDescription and constraints
$objectRoot
direct_manager_idstringOptionalThe direct manager of the person
Format: uuid
direct_reports_idsarrayOptionalThe direct reports of the person
direct_reports_ids[]stringEach itemFormat: uuid
idstringRequired within parentThe team that the person is part of
Format: uuid

Create a person without a contract — request body — body data invitation

FieldTypePresenceDescription and constraints
$objectRootOptional invitation configuration for the new hire. Defaults to 'disable' if not provided.
actionstringOptionalControls whether to send an invitation email.
One of: DISABLE, IMMEDIATE

Create a person without a contract — request body — body data person

FieldTypePresenceDescription and constraints
$objectRootThe person that is being hired
addressModelOptionalExpand Create a person without a contract — request body — body data person address
The home address of the person being hired
countrystringOptionalThe country of the person being hired
Maximum length: 2
Minimum length: 2
emailstringRequired within parentThe personal email of the person being hired
Format: email
Maximum length: 255
Minimum length: 3
end_datestringOptionalThe end date of the person being hired
Format: date
external_idstringOptionalAn external identifier for the person being hired
Maximum length: 100
first_namestringRequired within parentThe first name of the person being hired
Maximum length: 100
Minimum length: 1
job_titlestringOptionalThe job title of the person being hired
Maximum length: 255
last_namestringRequired within parentThe last name of the person being hired
Maximum length: 100
Minimum length: 1
nationalitystringOptionalThe nationality of the person being hired
Maximum length: 2
Minimum length: 2
preferred_first_namestringOptionalThe preferred first name of the person being hired
Maximum length: 100
Minimum length: 1
preferred_last_namestringOptionalThe preferred last name of the person being hired
Maximum length: 100
Minimum length: 1
senioritystringOptionalThe seniority of the person being hired
Maximum length: 255
start_datestringRequired within parentThe start date of the person being hired
Format: date
statestringOptionalThe state of the person being hired
Maximum length: 50
Minimum length: 1
work_emailstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThe home address of the person being hired
citystringOptionalThe city of the home address
countrystringRequired within parentThe country of the home address as an ISO 3166-1 alpha-2 code
Maximum length: 2
Minimum length: 2
line_twostring or nullOptionalThe second line of the home address
statestring or nullOptionalThe state or province of the home address
streetstringOptionalThe street and number of the home address
zipstringOptionalThe postal code of the home address

Get my current personal profile — 200 response body

FieldTypePresenceDescription and constraints
$objectRootPeople object representing a Deel
avatar_urlJSONOptional
avatar_url (anyOf 1)stringAlternativeURL of the user's avatar
avatar_url (anyOf 2)nullAlternativeURL of the user's avatar
client_countryJSONOptional
client_country (anyOf 1)stringAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
client_country (anyOf 2)nullAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
contractor_countryJSONOptional
contractor_country (anyOf 1)stringAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
contractor_country (anyOf 2)nullAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
emailstringOptionalEmail address of the user
first_namestringOptionalFirst name of the user
full_namestringOptionalFull name of the user
hris_enabledJSONOptional
hris_enabled (anyOf 1)booleanAlternativeHRIS feature enabled.
hris_enabled (anyOf 2)nullAlternativeHRIS feature enabled.
hris_organization_user_idJSONOptional
hris_organization_user_id (anyOf 1)stringAlternativeHRIS Organization User ID of the user. Used in products like Deel Engage.
Format: uuid
hris_organization_user_id (anyOf 2)nullAlternativeHRIS Organization User ID of the user. Used in products like Deel Engage.
Format: uuid
idJSONOptional
id (anyOf 1)numberAlternativeUnique identifier for the user profile
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
last_namestringOptionalLast name of the user
middle_nameJSONOptional
middle_name (anyOf 1)stringAlternativeMiddle name of the user
middle_name (anyOf 2)nullAlternativeMiddle name of the user
organization_idJSONOptional
organization_id (anyOf 1)numberAlternativeUnique identifier for the organization
Format: double
organization_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
organization_nameJSONOptional
organization_name (anyOf 1)stringAlternativeName of the organization
organization_name (anyOf 2)nullAlternativeName of the organization
profile_typestringOptionalType of profile
Known values: client, contractor, icp, direct_employee, hris_direct_employee, peo_employee, service_account
slack_team_idJSONOptional
slack_team_id (anyOf 1)stringAlternativeUser's team slack id
slack_team_id (anyOf 2)nullAlternativeUser's team slack id
slack_user_idJSONOptional
slack_user_id (anyOf 1)stringAlternativeUser's slack id
slack_user_id (anyOf 2)nullAlternativeUser's slack id
user_idJSONOptional
user_id (anyOf 1)numberAlternativeUnique identifier for the user
Format: double
user_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
usernamestringOptionalUsername of the user

List of People — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List of People — 200 response body — data item
pageModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
active_worker_termination_statusJSONOptionalThe status of the active worker termination.
active_worker_termination_status (anyOf 1)stringAlternativeThe status of the active worker termination.
Known values: PENDING, CONTRACT_TERMINATION_DATA_COLLECTED, IN_PROGRESS, COMPLETED, FAILED, CANCELED
active_worker_termination_status (anyOf 2)nullAlternative
additional_detailsJSONOptional
additional_details (anyOf 1)arrayAlternativeCountry-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)[]ModelEach itemExpand Retrieve a single person — 200 response body — data additional details null item
additional_details (anyOf 2)nullAlternativeCountry-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)[]ModelEach itemExpand Retrieve a single person — 200 response body — data additional details null item
addressesJSONOptional
addresses (anyOf 1)arrayAlternativeAn array of address objects containing the employee's physical addresses.
addresses (anyOf 1)[]ModelEach itemExpand List of People — 200 response body — data item addresses null item
addresses (anyOf 2)nullAlternativeAn array of address objects containing the employee's physical addresses.
addresses (anyOf 2)[]ModelEach itemExpand List of People — 200 response body — data item addresses null item
birth_dateJSONOptional
birth_date (anyOf 1)stringAlternativeThe birth date of the employee.
birth_date (anyOf 2)nullAlternativeThe birth date of the employee.
client_legal_entityModelOptionalExpand Retrieve a single person — 200 response body — data client legal entity
The primary client legal entity associated with the employee.
completion_dateJSONOptional
completion_date (anyOf 1)stringAlternativeThe completion date of the task or project.
completion_date (anyOf 2)nullAlternativeThe completion date of the task or project.
countryJSONOptional
country (anyOf 1)stringAlternativeThe country of the employee.
country (anyOf 2)nullAlternativeThe country of the employee.
created_atstringOptionalThe creation timestamp of the employee record.
Format: date-time
departmentModelOptionalExpand List of People — 200 response body — data item department
The department of the employee.
direct_employee_termination_last_daystringOptionalThe last day of work mentioned on the primary contract termination.
Format: date-time
direct_managerJSONOptionalThe direct manager of the employee.
direct_manager (anyOf 1)ModelAlternativeExpand List of People — 200 response body — data item direct manager The direct manager of the employee
direct_manager (anyOf 2)nullAlternative
direct_reportsJSONOptional
direct_reports (anyOf 1)arrayAlternativeThe direct reports to the employee.
direct_reports (anyOf 1)[]ModelEach itemExpand List of People — 200 response body — data item direct reports The direct reports to the employee item
direct_reports (anyOf 2)nullAlternativeThe direct reports to the employee.
direct_reports (anyOf 2)[]ModelEach itemExpand List of People — 200 response body — data item direct reports The direct reports to the employee item
direct_reports_countJSONOptional
direct_reports_count (anyOf 1)integerAlternativeThe count of direct reports to the employee.
direct_reports_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
emailsJSONOptional
emails (anyOf 1)arrayAlternativeAn array of the employee's email addresses.
emails (anyOf 1)[]ModelEach itemExpand List of People — 200 response body — data item emails An array of the employee's email addresses item
emails (anyOf 2)nullAlternativeAn array of the employee's email addresses.
emails (anyOf 2)[]ModelEach itemExpand List of People — 200 response body — data item emails An array of the employee's email addresses item
employmentsJSONOptional
employments (anyOf 1)arrayAlternativeAn array of employment records associated with the employee, including contract details, team information, payment details, and employment status.
employments (anyOf 1)[]ModelEach itemExpand List of People — 200 response body — data item employments null item
employments (anyOf 2)nullAlternativeAn array of employment records associated with the employee, including contract details, team information, payment details, and employment status.
employments (anyOf 2)[]ModelEach itemExpand List of People — 200 response body — data item employments null item
external_idJSONOptional
external_id (anyOf 1)stringAlternativeThe external ID of the employee.
external_id (anyOf 2)nullAlternativeThe external ID of the employee.
first_namestringOptionalThe first name of the employee.
full_namestringOptionalThe full name of the employee.
hiring_statusstringOptionalThe current hiring status of the employee.
hiring_typeJSONOptional
hiring_type (anyOf 1)stringAlternativeThe type of hiring of the employee.
hiring_type (anyOf 2)nullAlternativeThe type of hiring of the employee.
hris_organization_user_idJSONOptional
hris_organization_user_id (anyOf 1)stringAlternativeHRIS Organization User ID of the employee. Used in products like Deel Engage.
Format: uuid
hris_organization_user_id (anyOf 2)nullAlternativeHRIS Organization User ID of the employee. Used in products like Deel Engage.
Format: uuid
idstringOptionalUnique identifier for the employee.
is_pwacbooleanOptionalWhether the worker is a Person Without a Contract (PWAC)
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeThe job title of the employee.
job_title (anyOf 2)nullAlternativeThe job title of the employee.
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeThe last name of the employee.
last_name (anyOf 2)nullAlternativeThe last name of the employee.
middle_nameJSONOptional
middle_name (anyOf 1)stringAlternativeThe middle name of the employee.
middle_name (anyOf 2)nullAlternativeThe middle name of the employee.
nationalitiesarrayOptionalThe nationality of the employee.
nationalities[]stringEach item
new_hiring_statusJSONOptional
new_hiring_status (anyOf 1)stringAlternativeThe new hiring status of the employee.
new_hiring_status (anyOf 2)nullAlternativeThe new hiring status of the employee.
person_statusJSONOptionalLifecycle 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)stringAlternativeLifecycle 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)nullAlternative
preferred_first_nameJSONOptional
preferred_first_name (anyOf 1)stringAlternativeThe preferred first name of the employee.
preferred_first_name (anyOf 2)nullAlternativeThe preferred first name of the employee.
preferred_last_nameJSONOptional
preferred_last_name (anyOf 1)stringAlternativeThe preferred last name of the employee.
preferred_last_name (anyOf 2)nullAlternativeThe preferred last name of the employee.
seniorityJSONOptional
seniority (anyOf 1)stringAlternativeThe seniority level of the employee.
seniority (anyOf 2)nullAlternativeThe seniority level of the employee.
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeThe date the employee started working.
Format: date
start_date (anyOf 2)nullAlternativeThe date the employee started working.
Format: date
stateJSONOptional
state (anyOf 1)stringAlternativeThe state of the employee.
state (anyOf 2)nullAlternativeThe state of the employee.
timezoneJSONOptional
timezone (anyOf 1)stringAlternativeThe timezone of the employee.
timezone (anyOf 2)nullAlternativeThe timezone of the employee.
updated_atJSONOptional
updated_at (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
updated_at (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
work_locationJSONOptional
work_location (anyOf 1)stringAlternativeThe work location of the employee.
work_location (anyOf 2)nullAlternativeThe work location of the employee.
worker_idstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
country (anyOf 2)nullAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
lineTwostringOptionalSecond address line.
localitystringOptionalLocality name.
postalCodestringOptionalPostal code.
regionstringOptionalRegion code.
streetAddressstringOptionalStreet and number.

List of People — 200 response body — data item department

FieldTypePresenceDescription and constraints
$objectRootThe department of the employee.
idstringOptionalUnique identifier of this resource.
Format: uuid
namestringOptionalThe name of the department.
parentstringOptionalThe parent department name.

List of People — 200 response body — data item direct manager The direct manager of the employee

FieldTypePresenceDescription and constraints
$objectRootThe direct manager of the employee.
first_namestringOptionalThe first name of the manager.
idstringOptionalUnique identifier for the manager.
last_namestringOptionalThe last name of the manager.
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the manager.
work_email (anyOf 2)nullAlternativeThe work email of the manager.
worker_idJSONOptional
worker_id (anyOf 1)numberAlternativeThe worker ID of the manager.
Format: double
worker_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List of People — 200 response body — data item direct reports The direct reports to the employee item

FieldTypePresenceDescription and constraints
$objectRoot
first_namestringOptionalThe first name of the direct report.
idstringOptionalUnique identifier for the direct report.
last_namestringOptionalThe last name of the direct report.
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the direct report.
work_email (anyOf 2)nullAlternativeThe work email of the direct report.

List of People — 200 response body — data item emails An array of the employee's email addresses item

FieldTypePresenceDescription and constraints
$objectRoot
typeJSONOptional
type (anyOf 1)stringAlternativeThe type of email.
type (anyOf 2)nullAlternativeThe type of email.
valueJSONOptional
value (anyOf 1)stringAlternativeThe email address.
value (anyOf 2)nullAlternativeThe email address.

List of People — 200 response body — data item employments null item

FieldTypePresenceDescription and constraints
$objectRoot
band_placementJSONOptionalWhere the employee falls in their compensation band
band_placement (anyOf 1)stringAlternativeWhere the employee falls in their compensation band
Known values: ABOVE, WITHIN, BELOW
band_placement (anyOf 2)nullAlternative
client_legal_entityModelOptionalExpand 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_ratioJSONOptional
comparative_ratio (anyOf 1)JSONAlternative
comparative_ratio (anyOf 1) (anyOf 1)numberAlternativeNumber comparing an employee's compensation to the band midpoint
Format: double
comparative_ratio (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comparative_ratio (anyOf 2)nullAlternativeNumber comparing an employee's compensation to the band midpoint
Format: double
compensation_band_idJSONOptional
compensation_band_id (anyOf 1)stringAlternativeThe employee's assigned compensation band
compensation_band_id (anyOf 2)nullAlternativeThe employee's assigned compensation band
completion_dateJSONOptional
completion_date (anyOf 1)stringAlternativeThe completion date of the employment contract.
completion_date (anyOf 2)nullAlternativeThe completion date of the employment contract.
contract_coverageJSONOptionalThe coverage of the employment contract.
contract_coverage (anyOf 1)stringAlternativeThe coverage of the employment contract.
Known values: is_premium, is_shielded, no_coverage
contract_coverage (anyOf 2)nullAlternative
contract_has_contractorbooleanOptionalWhether the contract has a contractor.
contract_is_archivedbooleanOptionalWhether the employment contract is archived.
contract_statusstringOptionalThe status of the employment contract.
countryJSONOptional
country (anyOf 1)stringAlternativeThe country of employment.
country (anyOf 2)nullAlternativeThe country of employment.
emailstringOptionalThe work email of the employee.
has_eor_terminationJSONOptional
has_eor_termination (anyOf 1)booleanAlternativeWhether the employment has an EOR termination.
has_eor_termination (anyOf 2)nullAlternativeWhether the employment has an EOR termination.
hiring_statusstringOptionalThe current hiring status of the employment.
hiring_typeJSONOptional
hiring_type (anyOf 1)stringAlternativeThe type of hiring of the employment.
hiring_type (anyOf 2)nullAlternativeThe type of hiring of the employment.
hris_direct_employee_invitationJSONOptionalThe HRIS direct employee invitation status.
hris_direct_employee_invitation (anyOf 1)ModelAlternativeExpand 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)nullAlternative
idstringOptionalUnique identifier for the employment.
is_endedbooleanOptionalWhether the employment has ended.
is_user_contract_deletedbooleanOptionalWhether the user contract is deleted.
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeThe job title of the employment.
job_title (anyOf 2)nullAlternativeThe job title of the employment.
namestringOptionalName of the employee.
new_hiring_statusJSONOptional
new_hiring_status (anyOf 1)stringAlternativeThe new hiring status of the employment.
new_hiring_status (anyOf 2)nullAlternativeThe new hiring status of the employment.
paymentModelOptionalExpand 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.
seniorityJSONOptional
seniority (anyOf 1)stringAlternativeThe seniority level of the employment.
seniority (anyOf 2)nullAlternativeThe seniority level of the employment.
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeThe start date of the employment.
Format: date
start_date (anyOf 2)nullAlternativeThe start date of the employment.
Format: date
stateJSONOptional
state (anyOf 1)stringAlternativeThe state of employment.
state (anyOf 2)nullAlternativeThe state of employment.
teamModelOptionalExpand Retrieve a single person — 200 response body — data employments item team
The team to which the employee belongs.
termination_last_dayJSONOptional
termination_last_day (anyOf 1)stringAlternativeThe last day of work mentioned on the contract termination.
Format: date-time
termination_last_day (anyOf 2)nullAlternativeThe last day of work mentioned on the contract termination.
Format: date-time
timezoneJSONOptional
timezone (anyOf 1)stringAlternativeThe timezone of the employment.
timezone (anyOf 2)nullAlternativeThe timezone of the employment.
voluntarily_leftJSONOptional
voluntarily_left (anyOf 1)booleanAlternativeWhether the employee voluntarily left the employment.
voluntarily_left (anyOf 2)nullAlternativeWhether the employee voluntarily left the employment.
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the employment.
work_email (anyOf 2)nullAlternativeThe 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

FieldTypePresenceDescription and constraints
$objectRootPayment information for the employment, including rate, scale, currency, and associated contract name.
contract_namestringOptionalThe name of the contract associated with the payment
currencystringOptionalThe currency code (ISO 4217) for the payment
rateJSONOptional
rate (anyOf 1)stringAlternativeThe payment rate
rate (anyOf 2)nullAlternativeThe payment rate
scaleJSONOptional
scale (anyOf 1)stringAlternativeThe payment scale (e.g., hourly, weekly, monthly, etc.)
scale (anyOf 2)nullAlternativeThe payment scale (e.g., hourly, weekly, monthly, etc.)

List of People — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRoot
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)numberAlternativeFormat: double
Maximum: 200
Minimum: 1
items_per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)integerAlternativeMaximum: 999999999
Minimum: 0
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeFormat: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List of People — request body — query fields item

FieldTypePresenceDescription and constraints
$stringRootOne 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentAddresses of the worker.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
cityJSONRequired within parent
city (anyOf 1)stringAlternativeThe city.
city (anyOf 2)nullAlternativeThe city.
contract_idJSONRequired within parent
contract_id (anyOf 1)stringAlternativeContract the address belongs to; null for HOME and POSTAL addresses.
contract_id (anyOf 2)nullAlternativeContract the address belongs to; null for HOME and POSTAL addresses.
countrystringRequired within parentThe two-letter country code.
effective_dateJSONRequired within parent
effective_date (anyOf 1)stringAlternativeDate (YYYY-MM-DD) from which this version of the address applies.
Format: date
effective_date (anyOf 2)nullAlternativeDate (YYYY-MM-DD) from which this version of the address applies.
Format: date
idstringRequired within parentUnique identifier of the address, shared by its current and scheduled versions.
Format: uuid
line_twoJSONRequired within parent
line_two (anyOf 1)stringAlternativeThe second address line.
line_two (anyOf 2)nullAlternativeThe second address line.
stateJSONRequired within parent
state (anyOf 1)stringAlternativeThe state.
state (anyOf 2)nullAlternativeThe state.
streetJSONRequired within parent
street (anyOf 1)stringAlternativeThe street address.
street (anyOf 2)nullAlternativeThe street address.
typestringRequired within parentThe type of the address. Contract addresses are read-only on this API.
Known values: HOME, POSTAL, CONTRACT
zipJSONRequired within parent
zip (anyOf 1)stringAlternativeThe zip code.
zip (anyOf 2)nullAlternativeThe zip code.

Retrieve a single person — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
active_worker_termination_statusJSONOptionalThe status of the active worker termination.
active_worker_termination_status (anyOf 1)stringAlternativeThe status of the active worker termination.
Known values: PENDING, CONTRACT_TERMINATION_DATA_COLLECTED, IN_PROGRESS, COMPLETED, FAILED, CANCELED
active_worker_termination_status (anyOf 2)nullAlternative
additional_detailsJSONOptional
additional_details (anyOf 1)arrayAlternativeCountry-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)[]ModelEach itemExpand Retrieve a single person — 200 response body — data additional details null item
additional_details (anyOf 2)nullAlternativeCountry-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)[]ModelEach itemExpand Retrieve a single person — 200 response body — data additional details null item
addressesarrayOptionalAn array of address objects containing the employee's physical addresses.
addresses[]ModelEach itemExpand Retrieve a single person — 200 response body — data addresses item
birth_dateJSONOptional
birth_date (anyOf 1)stringAlternativeThe birth date of the employee.
birth_date (anyOf 2)nullAlternativeThe birth date of the employee.
client_legal_entityModelOptionalExpand Retrieve a single person — 200 response body — data client legal entity
The primary client legal entity associated with the employee.
completion_dateJSONOptional
completion_date (anyOf 1)stringAlternativeThe completion date of the task or project.
completion_date (anyOf 2)nullAlternativeThe completion date of the task or project.
countryJSONOptional
country (anyOf 1)stringAlternativeThe country of the employee.
country (anyOf 2)nullAlternativeThe country of the employee.
created_atstringOptionalThe creation timestamp of the employee record.
Format: date-time
custom_fieldsarrayOptionalAn array of custom field objects containing additional attributes associated with the employee (e.g., Job title, Project code, etc.).
custom_fields[]ModelEach itemExpand Retrieve a single person — 200 response body — data custom fields item
departmentModelOptionalExpand Retrieve a single person — 200 response body — data department
The department of the employee.
direct_employee_termination_last_daystringOptionalThe last day of work mentioned on the primary contract termination.
Format: date
direct_managerJSONOptionalThe direct manager of the employee.
direct_manager (anyOf 1)ModelAlternativeExpand Retrieve a single person — 200 response body — data direct manager The direct manager of the employee
direct_manager (anyOf 2)nullAlternative
direct_reportsJSONOptional
direct_reports (anyOf 1)arrayAlternativeThe direct reports to the employee.
direct_reports (anyOf 1)[]ModelEach itemExpand Retrieve a single person — 200 response body — data direct reports The direct reports to the employee item
direct_reports (anyOf 2)nullAlternativeThe direct reports to the employee.
direct_reports (anyOf 2)[]ModelEach itemExpand Retrieve a single person — 200 response body — data direct reports The direct reports to the employee item
direct_reports_countJSONOptional
direct_reports_count (anyOf 1)integerAlternativeThe count of direct reports to the employee.
direct_reports_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
emailsarrayOptionalAn array of the employee's email addresses.
emails[]ModelEach itemExpand Retrieve a single person — 200 response body — data emails item
employmentsarrayOptionalAn array of employment records associated with the employee, including contract details, team information, payment details, and employment status.
employments[]ModelEach itemExpand Retrieve a single person — 200 response body — data employments item
external_idJSONOptional
external_id (anyOf 1)stringAlternativeThe external ID of the employee.
external_id (anyOf 2)nullAlternativeThe external ID of the employee.
first_namestringOptionalThe first name of the employee.
full_namestringOptionalThe full name of the employee.
hiring_statusstringOptionalThe current hiring status of the employee.
hiring_typestringOptionalThe type of hiring of the employee.
idstringOptionalUnique identifier for the employee.
Format: uuid
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeThe job title of the employee.
job_title (anyOf 2)nullAlternativeThe job title of the employee.
last_namestringOptionalThe last name of the employee.
nationalitiesarrayOptionalThe nationality of the employee.
nationalities[]stringEach item
new_hiring_statusstringOptionalThe new hiring status of the employee.
preferred_first_nameJSONOptional
preferred_first_name (anyOf 1)stringAlternativeThe preferred first name of the employee.
preferred_first_name (anyOf 2)nullAlternativeThe preferred first name of the employee.
preferred_last_nameJSONOptional
preferred_last_name (anyOf 1)stringAlternativeThe preferred last name of the employee.
preferred_last_name (anyOf 2)nullAlternativeThe preferred last name of the employee.
profile_organizational_structuresarrayOptionalAn array of organizational structures associated with the employee profile.
profile_organizational_structures[]ModelEach itemExpand Retrieve a single person — 200 response body — data profile organizational structures item
seniorityJSONOptional
seniority (anyOf 1)stringAlternativeThe seniority level of the employee.
seniority (anyOf 2)nullAlternativeThe seniority level of the employee.
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeThe date the employee started working.
Format: date
start_date (anyOf 2)nullAlternativeThe date the employee started working.
Format: date
stateJSONOptional
state (anyOf 1)stringAlternativeThe state of the employee.
state (anyOf 2)nullAlternativeThe state of the employee.
timezoneJSONOptional
timezone (anyOf 1)stringAlternativeThe timezone of the employee.
timezone (anyOf 2)nullAlternativeThe timezone of the employee.
updated_atJSONOptional
updated_at (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
updated_at (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
work_locationJSONOptional
work_location (anyOf 1)stringAlternativeThe work location of the employee.
work_location (anyOf 2)nullAlternativeThe work location of the employee.
worker_idstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
countrystringOptionalISO-2 country code that scopes this entry.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
typestringOptionalField name (the JSONB key from hris_employment_eligibility.eligibility_data, e.g. socialSecurity, idNumber, taxIdentificationNumber).
valueModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$JSONRootRaw value associated with the field. May be a string, number, boolean, or null.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3)booleanAlternative
$ (anyOf 4)objectAlternativeAdditional keys: see wildcard field
$ (anyOf 4).*JSONAdditional keysAny type

Retrieve a single person — 200 response body — data addresses item

FieldTypePresenceDescription and constraints
$objectRoot
countrystringOptionalCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
localitystringOptionalLocality name.
postalCodestringOptionalPostal code.
regionstringOptionalRegion code.
streetAddressstringOptionalStreet and number.

Retrieve a single person — 200 response body — data client legal entity

FieldTypePresenceDescription and constraints
$objectRootThe primary client legal entity associated with the employee.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of this resource.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of this resource.
Format: uuid
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the client legal entity.
name (anyOf 2)nullAlternativeThe name of the client legal entity.

Retrieve a single person — 200 response body — data custom fields item

FieldTypePresenceDescription and constraints
$objectRootCustomized attributes on people (Job title, Project code, etc).
namestringOptionalCustom field property name.
valueJSONOptional
value (anyOf 1)stringAlternativeCustom field property value.
value (anyOf 2)nullAlternativeCustom field property value.

Retrieve a single person — 200 response body — data department

FieldTypePresenceDescription and constraints
$objectRootThe department of the employee.
idstringOptionalUnique identifier of this resource.
Format: uuid
namestringOptionalThe name of the department.
parentstringOptionalThe parent department.

Retrieve a single person — 200 response body — data direct manager The direct manager of the employee

FieldTypePresenceDescription and constraints
$objectRootThe direct manager of the employee.
first_namestringOptionalThe first name of the manager.
idstringOptionalUnique identifier for the manager.
Format: uuid
last_namestringOptionalThe last name of the manager.
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the manager.
work_email (anyOf 2)nullAlternativeThe work email of the manager.
worker_idJSONOptional
worker_id (anyOf 1)numberAlternativeThe worker ID of the manager.
Format: double
worker_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a single person — 200 response body — data direct reports The direct reports to the employee item

FieldTypePresenceDescription and constraints
$objectRoot
first_namestringOptionalThe first name of the direct report.
idstringOptionalUnique identifier for the direct report.
Format: uuid
last_namestringOptionalThe last name of the direct report.
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the direct report.
work_email (anyOf 2)nullAlternativeThe work email of the direct report.

Retrieve a single person — 200 response body — data emails item

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalThe type of email.
valueJSONOptional
value (anyOf 1)stringAlternativeThe email address.
value (anyOf 2)nullAlternativeThe email address.

Retrieve a single person — 200 response body — data employments item

FieldTypePresenceDescription and constraints
$objectRoot
client_legal_entityJSONOptionalThe client legal entity associated with this employment contract.
client_legal_entity (anyOf 1)ModelAlternativeExpand Retrieve a single person — 200 response body — data employments item client legal entity id, name
client_legal_entity (anyOf 2)nullAlternative
completion_dateJSONOptional
completion_date (anyOf 1)stringAlternativeThe completion date of the employment contract.
completion_date (anyOf 2)nullAlternativeThe completion date of the employment contract.
contract_coverageJSONOptionalThe coverage type of the employment contract. 'is_shielded' = Contractor of Record, 'is_premium' = Premium, null = Standard (no coverage).
contract_coverage (anyOf 1)stringAlternativeThe 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)nullAlternative
contract_has_contractorbooleanOptionalWhether the contract has a contractor.
contract_is_archivedbooleanOptionalWhether the employment contract is archived.
contract_statusstringOptionalThe status of the employment contract.
countryJSONOptional
country (anyOf 1)stringAlternativeThe country of employment.
country (anyOf 2)nullAlternativeThe country of employment.
emailstringOptionalThe work email of the employee.
has_eor_terminationJSONOptional
has_eor_termination (anyOf 1)booleanAlternativeWhether the employment has an EOR termination.
has_eor_termination (anyOf 2)nullAlternativeWhether the employment has an EOR termination.
hiring_statusstringOptionalThe current hiring status of the employment.
hiring_typestringOptionalThe type of hiring of the employment.
hris_direct_employee_invitationJSONOptionalThe HRIS direct employee invitation status.
hris_direct_employee_invitation (anyOf 1)ModelAlternativeExpand 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)nullAlternative
idstringOptionalUnique identifier for the employment.
is_endedbooleanOptionalWhether the employment has ended.
is_user_contract_deletedbooleanOptionalWhether the user contract is deleted.
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeThe job title of the employment.
job_title (anyOf 2)nullAlternativeThe job title of the employment.
namestringOptionalName of the employee.
new_hiring_statusstringOptionalThe new hiring status of the employment.
paymentModelOptionalExpand Retrieve a single person — 200 response body — data employments item payment
Payment information for the employment, including rate, scale, currency, and associated contract name.
seniorityJSONOptional
seniority (anyOf 1)stringAlternativeThe seniority level of the employment.
seniority (anyOf 2)nullAlternativeThe seniority level of the employment.
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeThe start date of the employment.
Format: date
start_date (anyOf 2)nullAlternativeThe start date of the employment.
Format: date
stateJSONOptional
state (anyOf 1)stringAlternativeThe state of employment.
state (anyOf 2)nullAlternativeThe state of employment.
teamModelOptionalExpand Retrieve a single person — 200 response body — data employments item team
The team to which the employee belongs.
termination_last_dayJSONOptional
termination_last_day (anyOf 1)stringAlternativeThe last day of work mentioned on the contract termination.
Format: date-time
termination_last_day (anyOf 2)nullAlternativeThe last day of work mentioned on the contract termination.
Format: date-time
timezoneJSONOptional
timezone (anyOf 1)stringAlternativeThe timezone of the employment.
timezone (anyOf 2)nullAlternativeThe timezone of the employment.
voluntarily_leftJSONOptional
voluntarily_left (anyOf 1)booleanAlternativeWhether the employee voluntarily left the employment.
voluntarily_left (anyOf 2)nullAlternativeWhether the employee voluntarily left the employment.
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the employment.
work_email (anyOf 2)nullAlternativeThe 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

FieldTypePresenceDescription and constraints
$objectRootThe client legal entity associated with this employment contract.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of this resource.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of this resource.
Format: uuid
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the client legal entity.
name (anyOf 2)nullAlternativeThe 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

FieldTypePresenceDescription and constraints
$objectRootThe HRIS direct employee invitation status.
oidstringOptionalUnique identifier of this resource.
send_atJSONOptional
send_at (anyOf 1)stringAlternativeThe HRIS direct employee invitation send date.
Format: date-time
send_at (anyOf 2)nullAlternativeThe HRIS direct employee invitation send date.
Format: date-time
statusJSONOptional
status (anyOf 1)stringAlternativeThe HRIS direct employee invitation status.
status (anyOf 2)nullAlternativeThe HRIS direct employee invitation status.
timezoneJSONOptional
timezone (anyOf 1)stringAlternativeThe HRIS direct employee invitation timezone.
timezone (anyOf 2)nullAlternativeThe HRIS direct employee invitation timezone.

Retrieve a single person — 200 response body — data employments item payment

FieldTypePresenceDescription and constraints
$objectRootPayment information for the employment, including rate, scale, currency, and associated contract name.
contract_namestringOptionalThe name of the contract associated with the payment
currencystringOptionalThe currency code (ISO 4217) for the payment
rateModelOptionalExpand Retrieve a single person — 200 response body — data employments item payment rate
The payment rate. Value is a string if contract type is PEO.
scaleJSONOptional
scale (anyOf 1)stringAlternativeThe payment scale (e.g., hourly, weekly, monthly, etc.)
scale (anyOf 2)nullAlternativeThe 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

FieldTypePresenceDescription and constraints
$JSONRootThe payment rate. Value is a string if contract type is PEO.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a single person — 200 response body — data employments item team

FieldTypePresenceDescription and constraints
$objectRootThe team to which the employee belongs.
idstringOptionalRefers to Groups in the platform. Working groups that reflect the organization's structure.
Format: uuid
namestringOptionalThe team name.

Retrieve a single person — 200 response body — data profile organizational structures item

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalId of the Organizational structure.
Format: uuid
namestringOptionalName of the Organizational structure.
teamsarrayOptionalList of teams in the organizational structure.
teams[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalId of the team.
Format: uuid
namestringOptionalName of the team.
name_hierarchyJSONOptional
name_hierarchy (anyOf 1)stringAlternativeHierarchy of the team.
name_hierarchy (anyOf 2)nullAlternativeHierarchy of the team.
positionsarrayOptionalAn array of positions held by the employee within this team.
positions[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalId of the position.
Format: uuid
is_supportivebooleanOptionalWhether the position is supportive or not.
roleJSONOptionalThe role associated with this position, including role ID and name.
role (anyOf 1)ModelAlternativeExpand Retrieve a single person — 200 response body — data profile organizational structures item teams item positions item role id, name
role (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootThe role associated with this position, including role ID and name.
idstringOptionalId of the role.
Format: uuid
namestringOptionalName of the role.

Update worker address by type — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe address version written by the request.
cityJSONRequired within parent
city (anyOf 1)stringAlternativeThe city.
city (anyOf 2)nullAlternativeThe city.
countrystringRequired within parentThe two-letter country code.
effective_dateJSONRequired within parent
effective_date (anyOf 1)stringAlternativeDate (YYYY-MM-DD) from which this version of the address applies.
Format: date
effective_date (anyOf 2)nullAlternativeDate (YYYY-MM-DD) from which this version of the address applies.
Format: date
idstringRequired within parentUnique identifier of the address.
Format: uuid
line_twoJSONRequired within parent
line_two (anyOf 1)stringAlternativeThe second address line.
line_two (anyOf 2)nullAlternativeThe second address line.
stateJSONRequired within parent
state (anyOf 1)stringAlternativeThe state.
state (anyOf 2)nullAlternativeThe state.
streetJSONRequired within parent
street (anyOf 1)stringAlternativeThe street address.
street (anyOf 2)nullAlternativeThe street address.
typestringRequired within parentThe type of the address.
Known values: HOME, POSTAL
zipJSONRequired within parent
zip (anyOf 1)stringAlternativeThe zip code.
zip (anyOf 2)nullAlternativeThe zip code.

Update worker address by type — request body — body data

FieldTypePresenceDescription and constraints
$objectRootAddress fields to change, with optional effective date and edit reason.
citystring or nullOptionalThe city.
countrystringOptionalThe two-letter country code. Required when the address is created; cannot be null.
edit_reasonJSONOptionalReason recorded with the change.
edit_reason (oneOf 1)ModelAlternativeExpand Update worker address by type — request body — body data edit reason Reason recorded with the change
edit_reason (oneOf 2)nullAlternative
effective_datestringOptionalDate (YYYY-MM-DD) from which the change applies; a future date schedules it.
Format: date
line_twostring or nullOptionalThe second address line.
statestring or nullOptionalThe state.
streetstring or nullOptionalThe street address.
zipstring or nullOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootReason recorded with the change.
additional_infostring or nullOptionalFree-text details about the change.
Maximum length: 2000
reason_oidstringOptionalPublic id of the edit reason.
Format: uuid

Update working location — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update working location — 200 response body — data

Referenced models: Update working location — 200 response body — data

Update working location — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
updatedbooleanRequired within parentIndicates if the resource was updated successfully.

Update working location — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
working_location_idnumberRequired within parentUnique identifier of this resource.
Format: double

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.