Retrieve policy validation templates | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/time_offs/policy-validation-templates"
querystring = {"countries":"[\"US\",\"CA\"]"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "data": {
    "policy_types": [
      {
        "id": "3597fd10-8f72-4ae2-805f-71a8ec39c28e",
        "name": "Maternity leave",
        "description": "Maternity leave"
      }
    ],
    "policy_validation_templates": [
      {
        "id": "4a8dd7c5-e2c6-499b-a333-88180e8ada6b",
        "country": "CA",
        "leave_type": "SHORT_TERM_LEAVE",
        "policy_type": {
          "id": "3597fd10-8f72-4ae2-805f-71a8ec39c28e",
          "name": "Maternity leave",
          "description": "Maternity leave"
        },
        "template_name": "Canada Maternity Leave Template",
        "tracking_unit": "YEAR",
        "policy_type_id": "3597fd10-8f72-4ae2-805f-71a8ec39c28e",
        "tracking_cadence": "ANNIVERSARY",
        "policy_allowances": [
          {
            "id": "25a92212-dac7-4410-b709-122164f0647f",
            "name": "Base Allowance",
            "type": "BASE_ALLOWANCE",
            "accrual_type": "TIMEFRAME",
            "accrual_unit": "MONTH",
            "rollover_type": "NO_ROLLOVER",
            "entitlement_unit": "CALENDAR_DAY",
            "termination_type": "NO_PAYOUT",
            "accrual_unit_amount": 2,
            "enable_bank_holidays": true,
            "accrual_prorate_types": [
              "PRORATE_UNPAID_LEAVE"
            ],
            "balance_tracking_type": "FLEXIBLE_NO_LIMIT",
            "entitlement_start_type": "IMMEDIATELY",
            "entitlement_start_unit": "MONTH",
            "entitlement_unit_amount": 245,
            "accrual_application_type": "BEGIN_OF_CYCLE",
            "rollover_expiration_unit": "MONTH",
            "additional_allowance_rules": [],
            "rollover_limit_unit_amount": 5,
            "entitlement_expiration_unit": "MONTH",
            "entitlement_start_unit_amount": 3,
            "rollover_expiration_unit_amount": 6,
            "entitlement_expiration_unit_amount": 12,
            "zero_out_negative_balances_on_rollover": true,
            "part_time_worker_additional_allowance_type": "SAME_AS_FTE",
            "balance_tracking_flexible_custom_request_amount": 10
          }
        ],
        "is_payment_top_off": false,
        "notice_period_unit": "DAY",
        "request_start_type": "IMMEDIATELY",
        "request_start_unit": "MONTH",
        "benefits_payer_type": "ORGANIZATION",
        "tracking_start_date": "2023-01-01",
        "attachment_condition": "GREATER_THAN",
        "overlap_request_type": "NOT_ALLOWED",
        "enabled_policy_fields": [
          "string"
        ],
        "require_notice_period": false,
        "time_off_request_type": "FULL_DAY",
        "enable_pay_out_balance": false,
        "adoption_date_definition": "FORBIDDEN",
        "allow_estimated_end_date": false,
        "max_tracking_unit_amount": 1,
        "min_tracking_unit_amount": 1,
        "attachment_condition_unit": "DAY",
        "max_time_off_per_tracking": 30,
        "min_time_off_per_tracking": 1,
        "notice_period_unit_amount": 7,
        "time_off_type_validations": [],
        "allow_approvers_to_request": true,
        "policy_allowance_proration": {
          "id": "16eb330d-6e89-4e94-ae94-e3800214b2ec",
          "has_partial_prorate": true,
          "hire_proration_rule": "NO_PRORATION",
          "is_accrual_prorate_policy": false,
          "termination_proration_rule": "NO_PRORATION",
          "hire_proration_cut_off_date": 15,
          "part_time_worker_treatment_type": "SAME_AS_FTE",
          "termination_proration_cut_off_date": 15,
          "part_time_worker_treatment_specific_amount": 20,
          "max_part_time_worker_treatment_specific_amount": 30,
          "min_part_time_worker_treatment_specific_amount": 10
        },
        "retrospective_request_type": "ALLOWED",
        "attachment_condition_amount": 5,
        "disable_termination_editing": false,
        "include_in_termination_flow": false,
        "max_entitlement_unit_amount": 427,
        "min_entitlement_unit_amount": 245,
        "upload_attachment_condition": "NOT_REQUIRED",
        "allow_to_edit_past_time_offs": true,
        "max_request_start_unit_amount": 12,
        "min_request_start_unit_amount": 1,
        "default_entitlement_unit_amount": 245,
        "maximum_time_off_request_amount": 90,
        "minimum_time_off_request_amount": 0.5,
        "auto_approval_inactivity_time_unit": "DAY",
        "enable_absence_percentage_requests": false,
        "estimated_end_date_client_reminder": [
          1
        ],
        "estimated_end_date_worker_reminder": [
          1
        ],
        "policy_validation_template_reminders": [],
        "is_auto_approval_on_inactivity_enabled": false,
        "allow_time_off_payment_treatment_upsert": false,
        "ops_workbench_process_template_reference": "maternity-leave-process-v1",
        "auto_approval_inactivity_time_unit_amount": 3,
        "enable_accrued_days_for_policy_on_termination_flow": false,
        "enable_high_accuracy_accrued_days_on_termination_flow": false
      }
    ]
  }
}

Retrieves policy validation templates and policy types based on the provided countries. Policy types are unique. 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/

Query parameters

countrieslist of stringsRequired

List of countries (ISO 3166-1 alpha-2 codes) to fetch policy templates and types for.

Response

Successful operation.

dataobject or null

Authentication

Authentication

Query parameters

Response

Errors

Authentication