Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.policy_typearrayOptional
query.policy_type[]ModelEach itemExpand List policies — request body — query policy type name
query.policy_namestringOptional
query.countryarrayOptional
query.country[]stringEach item
query.state_or_regionarrayOptional
query.state_or_region[]stringEach item
query.worker_types_assignedarrayOptional
query.worker_types_assigned[]stringEach item
query.has_workers_assignedbooleanOptional
query.page_sizeintegerOptionalMaximum: 50
Minimum: 1
query.nextstringOptional

Referenced models: List policies — request body — query policy type name

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Policies for Organization — 200 response body

Referenced models: Get Policies for Organization — 200 response body

8 more schemas are linked from the tables above, on the schema pages.

Get Policies for Organization — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get Policies for Organization — 200 response body — data item
has_next_pagebooleanOptionalIndicates if there are more results available beyond the current page
nextJSONOptional
next (anyOf 1)stringAlternativeOpaque cursor to fetch the next page of results. Null when there are no more results
next (anyOf 2)nullAlternativeOpaque 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
FieldTypePresenceDescription and constraints
$stringRootOne 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
FieldTypePresenceDescription and constraints
$objectRoot
assigned_profiles_countJSONRequired within parent
assigned_profiles_count (anyOf 1)integerAlternativeCount of profiles assigned to this policy.
assigned_profiles_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
auto_approval_inactivity_time_unitstringOptionalUnit 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_amountJSONOptional
auto_approval_inactivity_time_unit_amount (anyOf 1)numberAlternativeAmount 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentTimestamp when the policy was created
Format: date-time
custom_fieldsarrayRequired within parentThe custom fields the policy declares. Empty when the policy collects none.
custom_fields[]ModelEach itemExpand Validate time-off request — 200 response body — data custom fields item
descriptionstringOptionalPolicy description
has_custom_fieldsbooleanRequired within parentWhether the policy collects any custom field answers on its requests.
idstringRequired within parentPolicy UID
Format: uuid
is_attachment_requiredbooleanRequired within parentIndicates if an attachment is required for the time off request
is_description_requiredbooleanRequired within parentIndicates if a description is required for the time off request
is_event_basedbooleanRequired within parentIndicates 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_fieldsbooleanRequired within parentWhether 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_typestringRequired within parentType 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
namestringRequired within parentPolicy name
notice_period_unitstringOptionalUnit 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_amountJSONOptional
notice_period_unit_amount (anyOf 1)numberAlternativeAmount of time units used for calculating the notice period, if applicable
Format: double
notice_period_unit_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
overlap_request_typestringRequired within parentDefines if overlap requests are allowed or not. Overlap requests are requests that overlap with existing time off requests
Known values: ALLOWED, NOT_ALLOWED
payment_typestringRequired within parentType of payment for the time off
Known values: PAID, UNPAID, PARTIALLY_PAID
policy_allowance_prorationModelRequired within parentExpand Get Policies for Organization — 200 response body — data item policy allowance proration
Details of the proration rules for the policy allowance
policy_allowancesarrayRequired within parentDetails of the policy allowances associated with this policy
policy_allowances[]ModelEach itemExpand Get Policies for Organization — 200 response body — data item policy allowances item
policy_typeModelRequired within parentExpand Get Policies for Organization — 200 response body — data item policy type
Details of the policy type associated with this policy
request_start_typestringRequired within parentDefines 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_unitstringOptionalUnit 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_amountJSONOptional
request_start_unit_amount (anyOf 1)numberAlternativeAmount 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
retrospective_request_typestringRequired within parentDefines 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_offsbooleanRequired within parentIndicates if users are allowed to edit past time off requests
time_off_request_typestringRequired within parentType 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_typesarrayRequired within parent
time_off_types[]ModelEach itemExpand Get Policies for Organization — 200 response body — data item time off types item
tracking_cadencestringRequired within parentCadence 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_datestringOptionalStart 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_unitstringOptionalUnit of time used for calculating tracking periods
Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR
tracking_unit_amountJSONOptional
tracking_unit_amount (anyOf 1)numberAlternativeAmount of the tracking unit
Format: double
tracking_unit_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentTimestamp 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
FieldTypePresenceDescription and constraints
$objectRootDetails of the proration rules for the policy allowance
is_prorated_on_hirebooleanRequired within parentIndicates if the allowance is prorated on hire
is_prorated_on_terminationbooleanRequired within parentIndicates if the allowance is prorated on termination
part_time_worker_treatment_specific_amountJSONOptional
part_time_worker_treatment_specific_amount (anyOf 1)JSONAlternative
part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1)numberAlternativeSpecific amount for part-time worker treatment, if applicable.
Format: double
part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
part_time_worker_treatment_specific_amount (anyOf 2)nullAlternativeSpecific amount for part-time worker treatment, if applicable.
Format: double
part_time_worker_treatment_typestringRequired within parentDefines 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

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.