Skip to navigation

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

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

hris_profile_idstringRequiredformat: "uuid"
HRIS profile ID

Query parameters

policy_type_nameenumOptional
Policy type name
tracking_period_datestringOptionalformat: "date"
Tracking period date

Response

Successful response
entitlementslist of objects
hris_profile_idstring
HRIS profile ID

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error