Deel: Get Policies for Organization — 200 response body — data item
Get Policies for Organization: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Get Policies for Organization — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assigned_profiles_count | JSON | Required within parent | |
assigned_profiles_count (anyOf 1) | integer | Alternative | Count of profiles assigned to this policy. |
assigned_profiles_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
auto_approval_inactivity_time_unit | string | Optional | Unit of time used for calculating the auto-approval after inactivity on reviewing the leave, if applicable Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
auto_approval_inactivity_time_unit_amount | JSON | Optional | |
auto_approval_inactivity_time_unit_amount (anyOf 1) | number | Alternative | Amount of time units used for calculating the auto-approval after inactivity on reviewing the leave, if applicable Format: double |
auto_approval_inactivity_time_unit_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Timestamp when the policy was created Format: date-time |
custom_fields | array | Required within parent | The custom fields the policy declares. Empty when the policy collects none. |
custom_fields[] | Model | Each item | Expand Validate time-off request — 200 response body — data custom fields item |
description | string | Optional | Policy description |
has_custom_fields | boolean | Required within parent | Whether the policy collects any custom field answers on its requests. |
id | string | Required within parent | Policy UID Format: uuid |
is_attachment_required | boolean | Required within parent | Indicates if an attachment is required for the time off request |
is_description_required | boolean | Required within parent | Indicates if a description is required for the time off request |
is_event_based | boolean | Required within parent | Indicates if the policy’s base allowance accrues based on an event (e.g., a life event like child birth) rather than on a time-based schedule |
is_requiring_custom_fields | boolean | Required within parent | Whether at least one of the policy’s custom fields can be mandatory (ALWAYS_REQUIRED or REQUIRED_CONDITIONALLY). False when every custom field is OPTIONAL, or when the policy has none. |
leave_type | string | Required within parent | Type of leave policy. Either short-term leave (e.g., PTO, vacation) or long-term leave (e.g., maternity, paternity) Known values: SHORT_TERM_LEAVE, LONG_TERM_LEAVE |
name | string | Required within parent | Policy name |
notice_period_unit | string | Optional | Unit of time used for calculating the notice period, if applicable. This is the minimum amount of time before the start of the leave that a worker must submit a request Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
notice_period_unit_amount | JSON | Optional | |
notice_period_unit_amount (anyOf 1) | number | Alternative | Amount of time units used for calculating the notice period, if applicable Format: double |
notice_period_unit_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
overlap_request_type | string | Required within parent | Defines if overlap requests are allowed or not. Overlap requests are requests that overlap with existing time off requests Known values: ALLOWED, NOT_ALLOWED |
payment_type | string | Required within parent | Type of payment for the time off Known values: PAID, UNPAID, PARTIALLY_PAID |
policy_allowance_proration | Model | Required within parent | Expand Get Policies for Organization — 200 response body — data item policy allowance proration Details of the proration rules for the policy allowance |
policy_allowances | array | Required within parent | Details of the policy allowances associated with this policy |
policy_allowances[] | Model | Each item | Expand Get Policies for Organization — 200 response body — data item policy allowances item |
policy_type | Model | Required within parent | Expand Get Policies for Organization — 200 response body — data item policy type Details of the policy type associated with this policy |
request_start_type | string | Required within parent | Defines when a the worker can start to request leaves. Either immediately or after a fixed period of time from the start of the tracking period Known values: IMMEDIATELY, FIXED_PERIOD |
request_start_unit | string | Optional | Unit of time used for calculating the request start period, if applicable. This is used when the request start type is FIXED_PERIOD Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
request_start_unit_amount | JSON | Optional | |
request_start_unit_amount (anyOf 1) | number | Alternative | Amount of time units used for calculating the request start period, if applicable. This is used when the request start type is FIXED_PERIOD Format: double |
request_start_unit_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
retrospective_request_type | string | Required within parent | Defines if retrospective requests are allowed or not. Retrospective requests are requests for time off in the past Known values: ALLOWED, NOT_ALLOWED |
should_allow_editing_past_time_offs | boolean | Required within parent | Indicates if users are allowed to edit past time off requests |
time_off_request_type | string | Required within parent | Type of time off request. Can be full day, half day, or partial day Known values: HALF_DAY, HOURLY, FULL_DAY, PERCENTAGE, PARTIAL_HOURS |
time_off_types | array | Required within parent | |
time_off_types[] | Model | Each item | Expand Get Policies for Organization — 200 response body — data item time off types item |
tracking_cadence | string | Required within parent | Cadence of the tracking period. Either a fixed day (e.g., Jan 1), based on the anniversary of the employee’s start date, or NOT_SPECIFIED if the policy has no tracking cadence configured Known values: FIXED_DAY, ANNIVERSARY, NOT_SPECIFIED |
tracking_start_date | string | Optional | Start date for tracking periods, if applicable. This is used when the tracking cadence is FIXED_DAY. So all tracking periods starts in the given month and day of each year Format: date |
tracking_unit | string | Optional | Unit of time used for calculating tracking periods Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
tracking_unit_amount | JSON | Optional | |
tracking_unit_amount (anyOf 1) | number | Alternative | Amount of the tracking unit Format: double |
tracking_unit_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Timestamp when the policy was last updated Format: date-time |
Referenced models: Validate time-off request — 200 response body — data custom fields item, Get Policies for Organization — 200 response body — data item policy allowance proration, Get Policies for Organization — 200 response body — data item policy allowances item, Get Policies for Organization — 200 response body — data item policy type, Get Policies for Organization — 200 response body — data item time off types item