Get Profile Entitlements | Deel

curl -G https://api.letsdeel.com/rest/v2/time_offs/profile/d290f1ee-6c54-4b01-90e6-d701748f0851/entitlements \
     -H "Authorization: Bearer <token>" \
     -d tracking_period_date=2022-01-01

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

List time-off entitlements. Token scopes: time-off:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

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

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication