Deel: List time-off requests — 200 response body — data item
List time-off requests: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: List time-off requests — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Amount of time off |
approved_at | JSON | Optional | |
approved_at (anyOf 1) | string | Alternative | Time off approval date Format: date-time |
approved_at (anyOf 2) | null | Alternative | Time off approval date Format: date-time |
contract_oid | string | Optional | Contract id |
created_at | string | Required within parent | Time off creation date Format: date-time |
custom_field_values | array | Optional | Answers to the custom fields the request policy declares. Omitted when the policy declares none. |
custom_field_values[] | Model | Each item | Expand Update time-off request — 200 response body — time off custom field values item |
deduction_amount | JSON | Optional | |
deduction_amount (anyOf 1) | string | Alternative | Deduction amount |
deduction_amount (anyOf 2) | null | Alternative | Deduction amount |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Time off description |
description (anyOf 2) | null | Alternative | Time off description |
end_date | string | Required within parent | End date of time off Format: date |
entitlement_unit | string | Required within parent | The unit in which the time off usage and entitlement are calculated. Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
half_end_date | boolean | Required within parent | Is half end date. Only used for backwards compatibility, please do not use. |
half_start_date | boolean | Required within parent | Is half start date. Only used for backwards compatibility, please do not use. |
id | string | Required within parent | Time off id Format: uuid |
is_end_date_estimated | boolean | Optional | Is end date estimated |
is_paid | boolean | Required within parent | Is time off paid |
other_type_description | JSON | Optional | |
other_type_description (anyOf 1) | string | Alternative | Other type description |
other_type_description (anyOf 2) | null | Alternative | Other type description |
reason | string | Optional | Reason for time off |
recipient_profile | Model | Optional | Expand List time-off requests — 200 response body — data item recipient profile |
requested_at | string | Required within parent | Time off request date Format: date |
requester_profile | Model | Optional | Expand List time-off requests — 200 response body — data item requester profile |
start_date | string | Required within parent | Start date of time off Format: date |
status | string | Optional | Status of time off Known values: REQUESTED, APPROVED, REJECTED, USED, CANCELED |
time_off_dailies | array | Optional | |
time_off_dailies[] | Model | Each item | Expand List time-off requests — 200 response body — data item time off dailies item |
time_off_percentage | JSON | Optional | |
time_off_percentage (anyOf 1) | string | Alternative | Time off percentage |
time_off_percentage (anyOf 2) | null | Alternative | Time off percentage |
time_off_type_id | string | Required within parent | Time off type id |
updated_at | string | Required within parent | Time off update date Format: date-time |
Referenced models: Update time-off request — 200 response body — time off custom field values item, List time-off requests — 200 response body — data item recipient profile, List time-off requests — 200 response body — data item requester profile, List time-off requests — 200 response body — data item time off dailies item