Deel: Get Profile Entitlements — 200 response body — entitlements item
Get Profile Entitlements: 200 response body, field entitlements / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Get Profile Entitlements — 200 response body — entitlements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accrual_amount | string | Optional | Accrual amount |
accrual_unit | string | Optional | Accrual unit Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
accrued | JSON | Optional | |
accrued (anyOf 1) | string | Alternative | Accrued time off |
accrued (anyOf 2) | null | Alternative | Accrued time off |
allowance | JSON | Optional | |
allowance (anyOf 1) | string | Alternative | Time off allowance |
allowance (anyOf 2) | null | Alternative | Time off allowance |
approved | string | Optional | Approved time off |
available | JSON | Required within parent | |
available (anyOf 1) | string | Alternative | Available time off. Will be null if is_allowance_unlimited is true |
available (anyOf 2) | null | Alternative | Available time off. Will be null if is_allowance_unlimited is true |
balance_adjusted | JSON | Optional | |
balance_adjusted (anyOf 1) | string | Alternative | Balance adjusted |
balance_adjusted (anyOf 2) | null | Alternative | Balance adjusted |
events | JSON | Optional | |
events (anyOf 1) | array | Alternative | |
events (anyOf 1)[] | Model | Each item | Expand Get Profile Entitlements — 200 response body — entitlements item events null item |
events (anyOf 2) | null | Alternative | |
events (anyOf 2)[] | Model | Each item | Expand Get Profile Entitlements — 200 response body — entitlements item events null item |
expired | string | Optional | Expired time off |
future_events | JSON | Optional | |
future_events (anyOf 1) | array | Alternative | |
future_events (anyOf 1)[] | Model | Each item | Expand Get Profile Entitlements — 200 response body — entitlements item events null item |
future_events (anyOf 2) | null | Alternative | |
future_events (anyOf 2)[] | Model | Each item | Expand Get Profile Entitlements — 200 response body — entitlements item events null item |
id | string | Optional | Entitlement ID |
is_allowance_unlimited | boolean | Required within parent | True when the allowance is unlimited |
past_tracking_periods | array | Optional | |
past_tracking_periods[] | string | Each item | |
policy | Model | Optional | Expand Get Profile Entitlements — 200 response body — entitlements item policy |
requested | string | Optional | Requested time off |
rollovers | JSON | Optional | |
rollovers (anyOf 1) | array | Alternative | |
rollovers (anyOf 1)[] | Model | Each item | Expand Get Profile Entitlements — 200 response body — entitlements item rollovers null item |
rollovers (anyOf 2) | null | Alternative | |
rollovers (anyOf 2)[] | Model | Each item | Expand Get Profile Entitlements — 200 response body — entitlements item rollovers null item |
time_off_event_id | string | Optional | Time off event ID |
total_entitlements | string | Required within parent | Total entitlements |
tracking_period | string | Required within parent | Tracking period |
tracking_period_end_date | JSON | Required within parent | |
tracking_period_end_date (anyOf 1) | string | Alternative | Tracking period end date. Null when the entitlement never expires. |
tracking_period_end_date (anyOf 2) | null | Alternative | Tracking period end date. Null when the entitlement never expires. |
upcoming_accruals | string | Optional | Upcoming accruals |
used | string | Optional | Used time off |
Referenced models: Get Profile Entitlements — 200 response body — entitlements item events null item, Get Profile Entitlements — 200 response body — entitlements item policy, Get Profile Entitlements — 200 response body — entitlements item rollovers null item