Skip to content

Deel: Retrieve Employee Time Off Data for Offboarding — 200 response body — data entitlements item

Retrieve Employee Time Off Data for Offboarding: 200 response body, field data / entitlements / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Retrieve Employee Time Off Data for Offboarding — 200 response body — data entitlements item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentWhen the entitlement was created
Format: date-time
entitlement_unitstringRequired within parentUnit of time measurement
Known values: BUSINESS_DAY, CALENDAR_DAY, HOUR, WEEK, MONTH, YEAR
idstringRequired within parentThe entitlement ID
Format: uuid
requestsJSONRequired within parent
requests (anyOf 1)integerAlternativeNumber of time off requests in this period
requests (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tracking_periodstringRequired within parentThe tracking period start date
Format: date
tracking_period_end_datestringRequired within parentThe tracking period end date
Format: date
updated_atstringRequired within parentWhen the entitlement was updated
Format: date-time
usedJSONRequired within parent
used (anyOf 1)numberAlternativeAmount of time off used in this period
Format: double
used (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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.