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
| 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