Deel: Get Profile Entitlements
Deel timeOff.getTimeOffEntitlements: arguments, response, policy and SDK examples.
← Time off operations · Get started
Operation deel.timeoff_gettimeoffentitlements
Provider route: GET /time_offs/profile/{hris_profile_id}/entitlements. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["timeOff"]["getTimeOffEntitlements"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.timeOff.getTimeOffEntitlements(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.time_off.get_time_off_entitlements(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.hris_profile_id | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.policy_type_name | Model | Optional | Expand List policies — request body — query policy type name |
query.tracking_period_date | string | Optional | Format: date |
Referenced models: List policies — request body — query policy type name
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get Profile Entitlements — 200 response body |
Referenced models: Get Profile Entitlements — 200 response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Get Profile Entitlements — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entitlements | array | Required within parent | |
entitlements[] | Model | Each item | Expand Get Profile Entitlements — 200 response body — entitlements item |
hris_profile_id | string | Required within parent | HRIS profile ID |
Referenced models: Get Profile Entitlements — 200 response body — entitlements item
List policies — request body — query policy type name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | One of: Adoption leave, Advanced vacation, Bereaved partner's paternity leave, Bereavement leave, Blood donation leave, Breastfeeding leave, Carer's leave, Childbirth leave, Childcare leave, Civic/public duty leave, Compensatory leave, Disability leave, Doctor's appointment leave, Family & domestic violence leave, Family responsibility leave, Floating Holiday Allowance, Hajj leave, Hospitalization leave, Long Service Leave, Marriage/wedding leave, Maternity leave, Menstrual leave, Military leave, Moving leave, Neonatal care leave, Other leave, Paid leave, Parental bereavement leave, Parental leave, Paternity leave, Personal leave, Pregnancy leave, Regional holiday, RTT, Shared parental leave, Sick leave, Strike, Study leave, Supplementary Leave, Unpaid leave, Vacation, Vacation - public holidays replacement, Volunteer leave, Work accident leave, Work away from office, Work Location |
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
Get Profile Entitlements — 200 response body — entitlements item events null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accrual_date | string | Optional | Accrual date Format: date-time |
amount | string | Required within parent | Event amount |
created_at | string | Required within parent | Event creation date Format: date-time |
description | string | Optional | Event description |
event_date | string | Optional | Event date Format: date-time |
expiration_date | string | Optional | Expiration date Format: date-time |
id | string | Required within parent | Event ID Format: uuid |
policy_id | string | Required within parent | Policy ID Format: uuid |
profile_id | string | Required within parent | Profile ID Format: uuid |
rollover_tracking_period | string | Optional | Rollover tracking period Format: date-time |
time_off_id | string | Optional | Time off ID Format: uuid |
tracking_period | string | Required within parent | Tracking period Format: date-time |
type | string | Required within parent | Event type Known values: ACCRUAL, ACCRUAL_DEDUCTION, ACCRUAL_PRORATE, ACCRUAL_TERMINATION, MANUAL_ADJUSTMENT, NO_ROLLOVER, ROLLOVER_ADJUSTMENT, ROLLOVER_CARRY_OVER, ROLLOVER_EXPIRATION, ROLLOVER_PAYOUT, ROLLOVER_PROJECTED, TIME_OFF |
updated_at | string | Required within parent | Event update date Format: date-time |
Get Profile Entitlements — 200 response body — entitlements item policy
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Policy creation date Format: date-time |
description | string | Optional | Policy description |
id | string | Required within parent | Policy ID Format: uuid |
leave_type | string | Optional | Leave type Known values: SHORT_TERM_LEAVE, LONG_TERM_LEAVE |
name | string | Required within parent | Policy name |
policy_type | Model | Optional | Expand Get Profile Entitlements — 200 response body — entitlements item policy policy type |
policy_type_id | string | Optional | Policy type ID Format: uuid |
time_off_types | array | Optional | |
time_off_types[] | Model | Each item | Expand Get Profile Entitlements — 200 response body — entitlements item policy time off types item |
tracking_cadence | string | Optional | Tracking cadence Known values: FIXED_DAY, ANNIVERSARY, NOT_SPECIFIED |
tracking_start_date | string | Optional | Tracking start date Format: date |
tracking_unit | string | Optional | Tracking unit Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
tracking_unit_amount | string | Optional | Tracking unit amount |
updated_at | string | Required within parent | Policy update date Format: date-time |
Referenced models: Get Profile Entitlements — 200 response body — entitlements item policy policy type, Get Profile Entitlements — 200 response body — entitlements item policy time off types item
Get Profile Entitlements — 200 response body — entitlements item rollovers null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Get Profile Entitlements — 200 response body — entitlements item rollovers null item amount |
expiration_date | string | Optional | Rollover expiration date Format: date-time |
rollover_tracking_period | string | Required within parent | Rollover tracking period Format: date-time |
Referenced models: Get Profile Entitlements — 200 response body — entitlements item rollovers null item amount
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.timeoff_gettimeoffentitlements. Catalog operation: timeoff_gettimeoffentitlements. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["time-off:read"]
Pinned headers: {"X-Version": "2026-01-01"}