For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeel Home
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
  • Resources
    • Blog
    • Community
    • API spec
  • HRIS Guides
    • Introduction
  • HRIS Common Use Cases
    • Sync Deel users to identity providers
  • SCIM API
    • Overview
  • HRIS Endpoints
      • POSTApprove/Reject time-off requests
      • DELCancel time-off request
      • POSTCreate time-off request
      • POSTExternal HR Time Off Synchronization
      • GETGet Profile Entitlements
      • GETGet Time Off Events for Profile
      • GETGet Work Schedule and Holidays
      • GETList policies
      • GETList time-off requests
      • GETRetrieve policy validation templates
      • PATCHUpdate time-off request
      • POSTValidate time-off request
  • ATS Guides
    • Introduction
    • Getting started
    • Manage jobs
    • Manage candidates and applications
    • Webhooks
  • ATS Common Use Cases
    • From candidate to contract
  • ATS Endpoints
LogoLogo
SupportDeel Home
HRIS EndpointsTime Off

Retrieve policy validation templates

GET
/time_offs/policy-validation-templates
GET
/rest/v2/time_offs/policy-validation-templates
$curl -G https://api.letsdeel.com/rest/v2/time_offs/policy-validation-templates \
> -H "Authorization: Bearer <token>" \
> -d countries=US \
> -d countries=CA
1{
2 "data": {
3 "policy_types": [
4 {
5 "id": "3597fd10-8f72-4ae2-805f-71a8ec39c28e",
6 "name": "Maternity leave",
7 "description": "Maternity leave"
8 }
9 ],
10 "policy_validation_templates": [
11 {
12 "id": "4a8dd7c5-e2c6-499b-a333-88180e8ada6b",
13 "country": "CA",
14 "leave_type": "SHORT_TERM_LEAVE",
15 "policy_type": {
16 "id": "3597fd10-8f72-4ae2-805f-71a8ec39c28e",
17 "name": "Maternity leave",
18 "description": "Maternity leave"
19 },
20 "template_name": "Canada Maternity Leave Template",
21 "tracking_unit": "YEAR",
22 "policy_type_id": "3597fd10-8f72-4ae2-805f-71a8ec39c28e",
23 "tracking_cadence": "ANNIVERSARY",
24 "policy_allowances": [
25 {
26 "id": "25a92212-dac7-4410-b709-122164f0647f",
27 "name": "Base Allowance",
28 "type": "BASE_ALLOWANCE",
29 "accrual_type": "TIMEFRAME",
30 "accrual_unit": "MONTH",
31 "rollover_type": "NO_ROLLOVER",
32 "entitlement_unit": "CALENDAR_DAY",
33 "termination_type": "NO_PAYOUT",
34 "accrual_unit_amount": 2,
35 "enable_bank_holidays": true,
36 "accrual_prorate_types": [
37 "PRORATE_UNPAID_LEAVE"
38 ],
39 "balance_tracking_type": "FLEXIBLE_NO_LIMIT",
40 "entitlement_start_type": "IMMEDIATELY",
41 "entitlement_start_unit": "MONTH",
42 "entitlement_unit_amount": 245,
43 "accrual_application_type": "BEGIN_OF_CYCLE",
44 "rollover_expiration_unit": "MONTH",
45 "additional_allowance_rules": [],
46 "rollover_limit_unit_amount": 5,
47 "entitlement_expiration_unit": "MONTH",
48 "entitlement_start_unit_amount": 3,
49 "rollover_expiration_unit_amount": 6,
50 "entitlement_expiration_unit_amount": 12,
51 "zero_out_negative_balances_on_rollover": true,
52 "part_time_worker_additional_allowance_type": "SAME_AS_FTE",
53 "balance_tracking_flexible_custom_request_amount": 10
54 }
55 ],
56 "is_payment_top_off": false,
57 "notice_period_unit": "DAY",
58 "request_start_type": "IMMEDIATELY",
59 "request_start_unit": "MONTH",
60 "benefits_payer_type": "ORGANIZATION",
61 "tracking_start_date": "2023-01-01",
62 "attachment_condition": "GREATER_THAN",
63 "overlap_request_type": "NOT_ALLOWED",
64 "enabled_policy_fields": [
65 "string"
66 ],
67 "require_notice_period": false,
68 "time_off_request_type": "FULL_DAY",
69 "enable_pay_out_balance": false,
70 "adoption_date_definition": "FORBIDDEN",
71 "allow_estimated_end_date": false,
72 "max_tracking_unit_amount": 1,
73 "min_tracking_unit_amount": 1,
74 "attachment_condition_unit": "DAY",
75 "max_time_off_per_tracking": 30,
76 "min_time_off_per_tracking": 1,
77 "notice_period_unit_amount": 7,
78 "time_off_type_validations": [],
79 "allow_approvers_to_request": true,
80 "policy_allowance_proration": {
81 "id": "16eb330d-6e89-4e94-ae94-e3800214b2ec",
82 "has_partial_prorate": true,
83 "hire_proration_rule": "NO_PRORATION",
84 "is_accrual_prorate_policy": false,
85 "termination_proration_rule": "NO_PRORATION",
86 "hire_proration_cut_off_date": 15,
87 "part_time_worker_treatment_type": "SAME_AS_FTE",
88 "termination_proration_cut_off_date": 15,
89 "part_time_worker_treatment_specific_amount": 20,
90 "max_part_time_worker_treatment_specific_amount": 30,
91 "min_part_time_worker_treatment_specific_amount": 10
92 },
93 "retrospective_request_type": "ALLOWED",
94 "attachment_condition_amount": 5,
95 "disable_termination_editing": false,
96 "include_in_termination_flow": false,
97 "max_entitlement_unit_amount": 427,
98 "min_entitlement_unit_amount": 245,
99 "upload_attachment_condition": "NOT_REQUIRED",
100 "allow_to_edit_past_time_offs": true,
101 "max_request_start_unit_amount": 12,
102 "min_request_start_unit_amount": 1,
103 "default_entitlement_unit_amount": 245,
104 "maximum_time_off_request_amount": 90,
105 "minimum_time_off_request_amount": 0.5,
106 "auto_approval_inactivity_time_unit": "DAY",
107 "enable_absence_percentage_requests": false,
108 "estimated_end_date_client_reminder": [
109 1
110 ],
111 "estimated_end_date_worker_reminder": [
112 1
113 ],
114 "policy_validation_template_reminders": [],
115 "is_auto_approval_on_inactivity_enabled": false,
116 "allow_time_off_payment_treatment_upsert": false,
117 "ops_workbench_process_template_reference": "maternity-leave-process-v1",
118 "auto_approval_inactivity_time_unit_amount": 3,
119 "enable_accrued_days_for_policy_on_termination_flow": false,
120 "enable_high_accuracy_accrued_days_on_termination_flow": false
121 }
122 ]
123 }
124}

Returns policy validation templates and policy types for one or more countries, specified as ISO 3166-1 alpha-2 codes. Policy types in the response are unique across the result set. Token scopes: time-off:read

Was this page helpful?
Previous

Update time-off request

Next
Built with

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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
OR
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

Errors

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

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.

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

Learn more about authentication