List policies | Deel | Documentation

curl -G https://api.letsdeel.com/rest/v2/time_offs/profile/f7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b/policies \
     -H "Authorization: Bearer <token>" \
     --data-urlencode "policy_type_name=Adoption leave" \
     -d policy_type_id=f7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b

{
  "policies": [
    {
      "id": "c7f4986f-39a4-4f5d-9325-f37a8e9f5cdf",
      "name": "US PTO Policy",
      "created_at": "2023-01-01T00:00:00Z",
      "leave_type": "SHORT_TERM_LEAVE",
      "updated_at": "2023-01-15T12:30:45Z",
      "policy_type": {
        "id": "c7f4986f-39a4-4f5d-9325-f37a8e9f5cdf",
        "name": "Vacation"
      },
      "payment_type": "PAID",
      "tracking_unit": "YEAR",
      "policy_allowances": [
        {
          "id": "c7f4986f-39a4-4f5d-9325-f37a8e9f5cdf",
          "type": "BASE_ALLOWANCE",
          "accrual_type": "TIMEFRAME",
          "accrual_unit": "MONTH",
          "rollover_type": "CARRY_OVER",
          "entitlement_unit": "CALENDAR_DAY",
          "accrual_unit_amount": 1,
          "enable_bank_holidays": true,
          "balance_tracking_type": "FLEXIBLE_NO_LIMIT",
          "entitlement_start_date": "2023-01-01",
          "entitlement_start_type": "IMMEDIATELY",
          "entitlement_start_unit": "CALENDAR_DAY",
          "entitlement_unit_amount": 15,
          "accrual_application_type": "BEGIN_OF_CYCLE",
          "rollover_expiration_unit": "MONTH",
          "rollover_limit_unit_amount": 5,
          "entitlement_expiration_unit": "MONTH",
          "entitlement_start_unit_amount": 90,
          "rollover_expiration_unit_amount": 6,
          "entitlement_expiration_unit_amount": 3,
          "zero_out_negative_balances_on_rollover": true,
          "balance_tracking_flexible_custom_request_amount": 8,
          "part_time_prorated_entitlement_unit_amount": 7.5
        }
      ],
      "notice_period_unit": "BUSINESS_DAY",
      "request_start_type": "IMMEDIATELY",
      "request_start_unit": "BUSINESS_DAY",
      "overlap_request_type": "NOT_ALLOWED",
      "tracking_unit_amount": 1,
      "time_off_request_type": "HALF_DAY",
      "is_attachment_required": "REQUIRED",
      "is_description_required": true,
      "notice_period_unit_amount": 14,
      "request_start_unit_amount": 14,
      "policy_allowance_proration": {
        "prorates_on_hire": true,
        "prorates_on_termination": true,
        "part_time_worker_treatment_type": "CUSTOM_ENTITLEMENT",
        "part_time_worker_treatment_specific_amount": 12
      },
      "retrospective_request_type": "ALLOWED",
      "allow_to_edit_past_time_offs": false,
      "auto_approval_inactivity_time_unit": "CALENDAR_DAY",
      "auto_approval_inactivity_time_unit_amount": 3,
      "description": "Standard paid time off policy for US employees",
      "policy_type_id": "c7f4986f-39a4-4f5d-9325-f37a8e9f5cdf",
      "time_off_types": [
        {
          "id": "c7f4986f-39a4-4f5d-9325-f37a8e9f5cdf",
          "name": "Vacation",
          "description": "Annual vacation leave"
        }
      ],
      "tracking_cadence": "FIXED_DAY",
      "tracking_start_date": "2023-01-01"
    }
  ]
}

List policies for profile 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.

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

Learn more about authentication

## 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)

AuthorizationBearer

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

Path parameters

hris_profile_idstringRequiredformat: "uuid"

hrisProfileId id.

Query parameters

policy_type_nameenumOptional

Policy type name.

policy_type_idstringOptionalformat: "uuid"

policy type id

Response

Successful operation.

policieslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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