Deel: Get Policies for Organization
Deel timeOff.getPoliciesForOrganization: arguments, response, policy and SDK examples.
← Time off operations · Get started
Operation deel.timeoff_getpoliciesfororganization_v2026_09_09
Provider route: GET /time-offs/policy. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["timeOff"]["getPoliciesForOrganization"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.timeOff.getPoliciesForOrganization(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.time_off.get_policies_for_organization(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.policy_type | array | Optional | |
query.policy_type[] | Model | Each item | Expand List policies — request body — query policy type name |
query.policy_name | string | Optional | |
query.country | array | Optional | |
query.country[] | string | Each item | |
query.state_or_region | array | Optional | |
query.state_or_region[] | string | Each item | |
query.worker_types_assigned | array | Optional | |
query.worker_types_assigned[] | string | Each item | |
query.has_workers_assigned | boolean | Optional | |
query.page_size | integer | Optional | Maximum: 50 Minimum: 1 |
query.next | string | Optional |
Referenced models: List policies — request body — query policy type name
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get Policies for Organization — 200 response body |
Referenced models: Get Policies for Organization — 200 response body
Schemas
Section titled “Schemas”8 more schemas are linked from the tables above, on the schema pages.
Get Policies for Organization — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get Policies for Organization — 200 response body — data item |
has_next_page | boolean | Optional | Indicates if there are more results available beyond the current page |
next | JSON | Optional | |
next (anyOf 1) | string | Alternative | Opaque cursor to fetch the next page of results. Null when there are no more results |
next (anyOf 2) | null | Alternative | Opaque cursor to fetch the next page of results. Null when there are no more results |
Referenced models: Get Policies for Organization — 200 response body — data item
List policies — request body — query policy type name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | One of: Adoption leave, Advanced vacation, Bereaved partner's paternity leave, Bereavement leave, Blood donation leave, Breastfeeding leave, Carer's leave, Childbirth leave, Childcare leave, Civic/public duty leave, Compensatory leave, Disability leave, Doctor's appointment leave, Family & domestic violence leave, Family responsibility leave, Floating Holiday Allowance, Hajj leave, Hospitalization leave, Long Service Leave, Marriage/wedding leave, Maternity leave, Menstrual leave, Military leave, Moving leave, Neonatal care leave, Other leave, Paid leave, Parental bereavement leave, Parental leave, Paternity leave, Personal leave, Pregnancy leave, Regional holiday, RTT, Shared parental leave, Sick leave, Strike, Study leave, Supplementary Leave, Unpaid leave, Vacation, Vacation - public holidays replacement, Volunteer leave, Work accident leave, Work away from office, Work Location |
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
Get Policies for Organization — 200 response body — data item policy allowance proration
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the proration rules for the policy allowance |
is_prorated_on_hire | boolean | Required within parent | Indicates if the allowance is prorated on hire |
is_prorated_on_termination | boolean | Required within parent | Indicates if the allowance is prorated on termination |
part_time_worker_treatment_specific_amount | JSON | Optional | |
part_time_worker_treatment_specific_amount (anyOf 1) | JSON | Alternative | |
part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1) | number | Alternative | Specific amount for part-time worker treatment, if applicable. Format: double |
part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
part_time_worker_treatment_specific_amount (anyOf 2) | null | Alternative | Specific amount for part-time worker treatment, if applicable. Format: double |
part_time_worker_treatment_type | string | Required within parent | Defines how the allowance is prorated for part-time workers. Either no proration, full month proration based on day, tenure boundary proration, or country specific proration Known values: SAME_AS_FTE, PERCENTAGE_OF_FTE, BASED_ON_WORK_HOURS, BASED_ON_WORK_DAYS, CUSTOM_ENTITLEMENT |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.timeoff_getpoliciesfororganization_v2026_09_09. Catalog operation: timeoff_getpoliciesfororganization_v2026_09_09. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["time-off:read"]
Pinned headers: {"X-Version": "2026-09-09"}