Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.hris_profile_idstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.policy_type_nameModelOptionalExpand List policies — request body — query policy type name
query.tracking_period_datestringOptionalFormat: date

Referenced models: List policies — request body — query policy type name

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Profile Entitlements — 200 response body

Referenced models: Get Profile Entitlements — 200 response body

3 more schemas are linked from the tables above, on the schema pages.

Get Profile Entitlements — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
entitlementsarrayRequired within parent
entitlements[]ModelEach itemExpand Get Profile Entitlements — 200 response body — entitlements item
hris_profile_idstringRequired within parentHRIS profile ID

Referenced models: Get Profile Entitlements — 200 response body — entitlements item

List policies — request body — query policy type name
FieldTypePresenceDescription and constraints
$stringRootOne 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
FieldTypePresenceDescription and constraints
$objectRoot
accrual_amountstringOptionalAccrual amount
accrual_unitstringOptionalAccrual unit
Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR
accruedJSONOptional
accrued (anyOf 1)stringAlternativeAccrued time off
accrued (anyOf 2)nullAlternativeAccrued time off
allowanceJSONOptional
allowance (anyOf 1)stringAlternativeTime off allowance
allowance (anyOf 2)nullAlternativeTime off allowance
approvedstringOptionalApproved time off
availableJSONRequired within parent
available (anyOf 1)stringAlternativeAvailable time off. Will be null if is_allowance_unlimited is true
available (anyOf 2)nullAlternativeAvailable time off. Will be null if is_allowance_unlimited is true
balance_adjustedJSONOptional
balance_adjusted (anyOf 1)stringAlternativeBalance adjusted
balance_adjusted (anyOf 2)nullAlternativeBalance adjusted
eventsJSONOptional
events (anyOf 1)arrayAlternative
events (anyOf 1)[]ModelEach itemExpand Get Profile Entitlements — 200 response body — entitlements item events null item
events (anyOf 2)nullAlternative
events (anyOf 2)[]ModelEach itemExpand Get Profile Entitlements — 200 response body — entitlements item events null item
expiredstringOptionalExpired time off
future_eventsJSONOptional
future_events (anyOf 1)arrayAlternative
future_events (anyOf 1)[]ModelEach itemExpand Get Profile Entitlements — 200 response body — entitlements item events null item
future_events (anyOf 2)nullAlternative
future_events (anyOf 2)[]ModelEach itemExpand Get Profile Entitlements — 200 response body — entitlements item events null item
idstringOptionalEntitlement ID
is_allowance_unlimitedbooleanRequired within parentTrue when the allowance is unlimited
past_tracking_periodsarrayOptional
past_tracking_periods[]stringEach item
policyModelOptionalExpand Get Profile Entitlements — 200 response body — entitlements item policy
requestedstringOptionalRequested time off
rolloversJSONOptional
rollovers (anyOf 1)arrayAlternative
rollovers (anyOf 1)[]ModelEach itemExpand Get Profile Entitlements — 200 response body — entitlements item rollovers null item
rollovers (anyOf 2)nullAlternative
rollovers (anyOf 2)[]ModelEach itemExpand Get Profile Entitlements — 200 response body — entitlements item rollovers null item
time_off_event_idstringOptionalTime off event ID
total_entitlementsstringRequired within parentTotal entitlements
tracking_periodstringRequired within parentTracking period
tracking_period_end_dateJSONRequired within parent
tracking_period_end_date (anyOf 1)stringAlternativeTracking period end date. Null when the entitlement never expires.
tracking_period_end_date (anyOf 2)nullAlternativeTracking period end date. Null when the entitlement never expires.
upcoming_accrualsstringOptionalUpcoming accruals
usedstringOptionalUsed 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
FieldTypePresenceDescription and constraints
$objectRoot
accrual_datestringOptionalAccrual date
Format: date-time
amountstringRequired within parentEvent amount
created_atstringRequired within parentEvent creation date
Format: date-time
descriptionstringOptionalEvent description
event_datestringOptionalEvent date
Format: date-time
expiration_datestringOptionalExpiration date
Format: date-time
idstringRequired within parentEvent ID
Format: uuid
policy_idstringRequired within parentPolicy ID
Format: uuid
profile_idstringRequired within parentProfile ID
Format: uuid
rollover_tracking_periodstringOptionalRollover tracking period
Format: date-time
time_off_idstringOptionalTime off ID
Format: uuid
tracking_periodstringRequired within parentTracking period
Format: date-time
typestringRequired within parentEvent 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_atstringRequired within parentEvent update date
Format: date-time
Get Profile Entitlements — 200 response body — entitlements item policy
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentPolicy creation date
Format: date-time
descriptionstringOptionalPolicy description
idstringRequired within parentPolicy ID
Format: uuid
leave_typestringOptionalLeave type
Known values: SHORT_TERM_LEAVE, LONG_TERM_LEAVE
namestringRequired within parentPolicy name
policy_typeModelOptionalExpand Get Profile Entitlements — 200 response body — entitlements item policy policy type
policy_type_idstringOptionalPolicy type ID
Format: uuid
time_off_typesarrayOptional
time_off_types[]ModelEach itemExpand Get Profile Entitlements — 200 response body — entitlements item policy time off types item
tracking_cadencestringOptionalTracking cadence
Known values: FIXED_DAY, ANNIVERSARY, NOT_SPECIFIED
tracking_start_datestringOptionalTracking start date
Format: date
tracking_unitstringOptionalTracking unit
Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR
tracking_unit_amountstringOptionalTracking unit amount
updated_atstringRequired within parentPolicy 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
FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Get Profile Entitlements — 200 response body — entitlements item rollovers null item amount
expiration_datestringOptionalRollover expiration date
Format: date-time
rollover_tracking_periodstringRequired within parentRollover tracking period
Format: date-time

Referenced models: Get Profile Entitlements — 200 response body — entitlements item rollovers null item amount

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

Official provider source

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.