Skip to content

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

List of People: 200 response body, field data / item / employments / null / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: 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

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.