timeOff
Get Profile Entitlements
Use this endpoint to check a worker's current leave balance — total entitlement granted, days used, and days remaining — across all active policies for a given tracking period. Call it before approving a leave request to verify available balance, to surface entitlement data in an HR portal, or to sync leave balances to an external system. Filter by policy_type_name to scope results to a specific leave category, or pass tracking_period_date to retrieve the balance as of a past tracking period.
Token scopes: time-off:read
get/time_offs/profile/{hris_profile_id}/entitlements
Request
- Base URL: https://api.letsdeel.com/rest
- URL: https://api.letsdeel.com/rest/time_offs/profile/{hris_profile_id}/entitlements
- Auth: HTTP bearer
Path parameters
hris_profile_idstring uuid required
HRIS profile ID
Query parameters
policy_type_name'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' | 'Study leave' | 'Supplementary Leave' | 'Unpaid leave' | 'Vacation' | 'Vacation - public holidays replacement' | 'Volunteer leave' | 'Work accident leave' | 'Work Location'
Policy type name
tracking_period_datestring date
Tracking period date
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.