> This page is for API, version 2026-01-01 (Stable) (default).
> For other versions, use one of these documentation indexes:
> - 2026-01-01 (Stable) (default): https://developer.deel.com/api/stable/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.deel.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server.

# Get Profile Entitlements

GET https://api.letsdeel.com/rest/time_offs/profile/{hris_profile_id}/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`

Reference: https://developer.deel.com/api/reference/endpoints/time-off/get-time-off-entitlements

## Authentication

- `Authorization` header (bearer token, required) — ## 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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
- `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

## Servers

- `https://api.letsdeel.com/rest` (Production, default)
- `https://api-staging.letsdeel.com/rest` (Demo)

## Request

### Path parameters

- `hris_profile_id` (string, required) — HRIS profile ID

### Query parameters

- `policy_type_name` (enum, optional) — Policy type name
  - Allowed values: `Adoption leave`, `Advanced vacation`, `Bereavement leave`, `Blood donation leave`, `Breastfeeding 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`, `Other leave`, `Paid leave`, `Parental leave`, `Paternity leave`, `Personal leave`, `Pregnancy leave`, `Regional holiday`, `RTT`, `Sick leave`, `Study leave`, `Supplementary Leave`, `Unpaid leave`, `Vacation`, `Vacation - public holidays replacement`, `Volunteer leave`, `Work accident leave`, `Work Location`
- `tracking_period_date` (string, optional) — Tracking period date

## Response

### 200

Successful response

- `entitlements` (list of TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItems, required)
- `hris_profile_id` (string, required) — HRIS profile ID

## Errors

### 400 Bad Request Error

Operation failed.

- `errors` (list of TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaErrorsItems, optional)
- `request` (TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaRequest, optional)

### 401 Unauthorized Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

### 403 Forbidden Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

### 404 Not Found Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

### 500 Internal Server Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

## Types

### TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItems

- `available` (string, required, nullable) — Available time off. Will be null if is_allowance_unlimited is true
- `tracking_period` (string, required) — Tracking period
- `total_entitlements` (string, required) — Total entitlements
- `is_allowance_unlimited` (boolean, required) — True when the allowance is unlimited
- `tracking_period_end_date` (string, required, nullable) — Tracking period end date. Null when the entitlement never expires.
- `id` (string, optional) — Entitlement ID
- `used` (string, optional) — Used time off
- `events` (list of TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItems, optional, nullable)
- `policy` (TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicy, optional)
- `accrued` (string, optional, nullable) — Accrued time off
- `expired` (string, optional) — Expired time off
- `approved` (string, optional) — Approved time off
- `allowance` (string, optional, nullable) — Time off allowance
- `requested` (string, optional) — Requested time off
- `rollovers` (list of TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItems, optional, nullable)
- `accrual_unit` (enum, optional) — Accrual unit
  - Allowed values: `HOUR`, `BUSINESS_DAY`, `CALENDAR_DAY`, `WEEK`, `MONTH`, `YEAR`
- `future_events` (list of TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItems, optional, nullable)
- `accrual_amount` (string, optional) — Accrual amount
- `balance_adjusted` (string, optional, nullable) — Balance adjusted
- `time_off_event_id` (string, optional) — Time off event ID
- `upcoming_accruals` (string, optional) — Upcoming accruals
- `past_tracking_periods` (list of string, optional)

### TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaErrorsItems

- `path` (string, optional) — The JSON path where input validation failed
- `message` (string, optional) — A description of the returned error

### TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaRequest

- `url` (string, optional) — The relative URL of the failed request
- `code` (double, optional) — The code of the source handler which produced the returned error
- `docs` (string, optional) — A link to the official documentation for the requested endpoint resource
- `method` (string, optional) — The HTTP method of the failed request
- `source` (string, optional) — The source handler which produced the returned error
- `status` (double, optional) — The status code of the response
- `api_req_id` (string, optional) — The request ID of the failed request

### ApiErrorRequest

- `method` (string, optional) — The HTTP method of the failed request
- `url` (string, optional) — The relative URL of the failed request
- `status` (double, optional) — The status code of the response
- `api_req_id` (string, optional) — The request ID of the failed request
- `docs` (string, optional) — A link to the official documentation for the requested endpoint resource
- `source` (string, optional) — The source handler which produced the returned error
- `code` (double, optional) — The code of the source handler which produced the returned error

### ApiError

- `message` (string, optional) — A description of the returned error
- `path` (string, optional) — The JSON path where input validation failed

### TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItems

- `id` (string, required) — Event ID
- `type` (enum, required) — Event type
  - Allowed 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`
- `amount` (float, required) — Event amount
- `policy_id` (string, required) — Policy ID
- `created_at` (string, required) — Event creation date
- `profile_id` (string, required) — Profile ID
- `updated_at` (string, required) — Event update date
- `tracking_period` (string, required) — Tracking period
- `event_date` (string, optional) — Event date
- `description` (string, optional) — Event description
- `time_off_id` (string, optional) — Time off ID
- `accrual_date` (string, optional) — Accrual date
- `expiration_date` (string, optional) — Expiration date
- `rollover_tracking_period` (string, optional) — Rollover tracking period

### TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicy

- `id` (string, required) — Policy ID
- `name` (string, required) — Policy name
- `created_at` (string, required) — Policy creation date
- `updated_at` (string, required) — Policy update date
- `leave_type` (enum, optional) — Leave type
  - Allowed values: `SHORT_TERM_LEAVE`, `LONG_TERM_LEAVE`
- `description` (string, optional) — Policy description
- `policy_type` (TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyPolicyType, optional)
- `tracking_unit` (enum, optional) — Tracking unit
  - Allowed values: `HOUR`, `BUSINESS_DAY`, `CALENDAR_DAY`, `WEEK`, `MONTH`, `YEAR`
- `policy_type_id` (string, optional) — Policy type ID
- `time_off_types` (list of TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTimeOffTypesItems, optional)
- `tracking_cadence` (enum, optional) — Tracking cadence
  - Allowed values: `FIXED_DAY`, `ANNIVERSARY`, `NOT_SPECIFIED`
- `tracking_start_date` (string, optional) — Tracking start date
- `tracking_unit_amount` (float, optional) — Tracking unit amount

### TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItems

- `amount` (TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItemsAmount, required)
- `rollover_tracking_period` (string, required) — Rollover tracking period
- `expiration_date` (string, optional) — Rollover expiration date

### TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItems

- `id` (string, required) — Event ID
- `type` (enum, required) — Event type
  - Allowed 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`
- `amount` (float, required) — Event amount
- `policy_id` (string, required) — Policy ID
- `created_at` (string, required) — Event creation date
- `profile_id` (string, required) — Profile ID
- `updated_at` (string, required) — Event update date
- `tracking_period` (string, required) — Tracking period
- `event_date` (string, optional) — Event date
- `description` (string, optional) — Event description
- `time_off_id` (string, optional) — Time off ID
- `accrual_date` (string, optional) — Accrual date
- `expiration_date` (string, optional) — Expiration date
- `rollover_tracking_period` (string, optional) — Rollover tracking period

### TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyPolicyType

- `id` (string, required) — Policy type ID
- `name` (string, required) — Policy type name

### TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTimeOffTypesItems

- `id` (string, required) — Time off type ID
- `name` (string, required) — Time off type name

### TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItemsAmount

## Examples

**Response**

```json
{
  "entitlements": [
    {
      "available": "0",
      "tracking_period": "2022-01-01T00:00:00Z",
      "total_entitlements": "0",
      "is_allowance_unlimited": false,
      "tracking_period_end_date": "2022-01-01T00:00:00Z",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "used": "0",
      "events": [
        {
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "type": "ACCRUAL",
          "amount": 8,
          "policy_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "created_at": "2022-01-01T00:00:00Z",
          "profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "updated_at": "2022-01-01T00:00:00Z",
          "tracking_period": "2022-01-01T00:00:00Z",
          "event_date": "2022-01-01T00:00:00Z",
          "description": "Event description",
          "time_off_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "accrual_date": "2022-01-01T00:00:00Z",
          "expiration_date": "2022-01-01T00:00:00Z",
          "rollover_tracking_period": "2022-01-01T00:00:00Z"
        }
      ],
      "policy": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "name": "Policy name",
        "created_at": "2022-01-01T00:00:00Z",
        "updated_at": "2022-01-01T00:00:00Z",
        "leave_type": "SHORT_TERM_LEAVE",
        "description": "Policy description",
        "policy_type": {
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "name": "Policy type name"
        },
        "tracking_unit": "HOUR",
        "policy_type_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "time_off_types": [
          {
            "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "name": "Time off type name"
          }
        ],
        "tracking_cadence": "FIXED_DAY",
        "tracking_start_date": "2022-01-01",
        "tracking_unit_amount": 8
      },
      "accrued": "0",
      "expired": "0",
      "approved": "0",
      "allowance": "0",
      "requested": "0",
      "rollovers": [
        {
          "amount": 1.1,
          "rollover_tracking_period": "2022-01-01T00:00:00Z",
          "expiration_date": "2022-01-01T00:00:00Z"
        }
      ],
      "accrual_unit": "HOUR",
      "future_events": [
        {
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "type": "ACCRUAL",
          "amount": 8,
          "policy_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "created_at": "2022-01-01T00:00:00Z",
          "profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "updated_at": "2022-01-01T00:00:00Z",
          "tracking_period": "2022-01-01T00:00:00Z",
          "event_date": "2022-01-01T00:00:00Z",
          "description": "Event description",
          "time_off_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "accrual_date": "2022-01-01T00:00:00Z",
          "expiration_date": "2022-01-01T00:00:00Z",
          "rollover_tracking_period": "2022-01-01T00:00:00Z"
        }
      ],
      "accrual_amount": "0",
      "balance_adjusted": "0",
      "time_off_event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "upcoming_accruals": "0",
      "past_tracking_periods": [
        "string"
      ]
    }
  ],
  "hris_profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}
```

**SDK Code**

```python
import requests

url = "https://api.letsdeel.com/rest/time_offs/profile/d290f1ee-6c54-4b01-90e6-d701748f0851/entitlements"

querystring = {"policy_type_name":"Moving leave","tracking_period_date":"2022-01-01"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.letsdeel.com/rest/time_offs/profile/d290f1ee-6c54-4b01-90e6-d701748f0851/entitlements?policy_type_name=Moving+leave&tracking_period_date=2022-01-01';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.letsdeel.com/rest/time_offs/profile/d290f1ee-6c54-4b01-90e6-d701748f0851/entitlements?policy_type_name=Moving+leave&tracking_period_date=2022-01-01"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/time_offs/profile/d290f1ee-6c54-4b01-90e6-d701748f0851/entitlements?policy_type_name=Moving+leave&tracking_period_date=2022-01-01")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.letsdeel.com/rest/time_offs/profile/d290f1ee-6c54-4b01-90e6-d701748f0851/entitlements?policy_type_name=Moving+leave&tracking_period_date=2022-01-01")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.letsdeel.com/rest/time_offs/profile/d290f1ee-6c54-4b01-90e6-d701748f0851/entitlements?policy_type_name=Moving+leave&tracking_period_date=2022-01-01', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/time_offs/profile/d290f1ee-6c54-4b01-90e6-d701748f0851/entitlements?policy_type_name=Moving+leave&tracking_period_date=2022-01-01");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/time_offs/profile/d290f1ee-6c54-4b01-90e6-d701748f0851/entitlements?policy_type_name=Moving+leave&tracking_period_date=2022-01-01")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```