Skip to content

Deel: List policies

Deel timeOff.getTimeOffPolicies: arguments, response, policy and SDK examples.

← Time off operations · Get started

Operation deel.timeoff_gettimeoffpolicies

Provider route: GET /time_offs/profile/{hris_profile_id}/policies. 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"]["getTimeOffPolicies"]>[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.getTimeOffPolicies(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_time_off_policies(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.hris_profile_idstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.policy_type_nameModelOptionalExpand List policies — request body — query policy type name
query.policy_type_idstringOptionalFormat: uuid

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 List policies — 200 response body

Referenced models: List policies — 200 response body

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

List policies — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
policiesarrayOptional
policies[]ModelEach itemExpand List policies — 200 response body — policies item

Referenced models: List policies — 200 response body — policies 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
List policies — 200 response body — policies item
FieldTypePresenceDescription and constraints
$objectRootTime off policy
allow_to_edit_past_time_offsbooleanRequired within parentWhether editing past time offs is allowed
auto_approval_inactivity_time_unitJSONRequired within parentUnit for auto-approval inactivity time
auto_approval_inactivity_time_unit (anyOf 1)stringAlternativeUnit for auto-approval inactivity time
Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR
auto_approval_inactivity_time_unit (anyOf 2)nullAlternative
auto_approval_inactivity_time_unit_amountJSONRequired within parent
auto_approval_inactivity_time_unit_amount (anyOf 1)JSONAlternative
auto_approval_inactivity_time_unit_amount (anyOf 1) (anyOf 1)numberAlternativeAmount of auto-approval inactivity time units
Format: double
auto_approval_inactivity_time_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
auto_approval_inactivity_time_unit_amount (anyOf 2)nullAlternativeAmount of auto-approval inactivity time units
Format: double
created_atstringRequired within parentDate and time 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
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the policy
description (anyOf 2)nullAlternativeDescription of the policy
has_custom_fieldsbooleanRequired within parentWhether the policy collects any custom field answers on its requests.
idstringRequired within parentUnique identifier of the policy
Format: uuid
is_attachment_requiredstringRequired within parentWhether an attachment is required for time off requests
Known values: NOT_REQUIRED, REQUIRED, CONDITIONALLY_REQUIRED
is_description_requiredbooleanRequired within parentWhether a description is required for time off requests
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 for this policy
Known values: SHORT_TERM_LEAVE, LONG_TERM_LEAVE
namestringRequired within parentName of the policy
notice_period_unitJSONRequired within parentUnit for notice period
notice_period_unit (anyOf 1)stringAlternativeUnit for notice period
Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR
notice_period_unit (anyOf 2)nullAlternative
notice_period_unit_amountJSONRequired within parent
notice_period_unit_amount (anyOf 1)JSONAlternative
notice_period_unit_amount (anyOf 1) (anyOf 1)numberAlternativeAmount of notice period units
Format: double
notice_period_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
notice_period_unit_amount (anyOf 2)nullAlternativeAmount of notice period units
Format: double
overlap_request_typestringRequired within parentType of overlapping requests allowed
Known values: ALLOWED, NOT_ALLOWED
payment_typestringRequired within parentPayment type for the time off policy
Known values: PAID, UNPAID
policy_allowance_prorationModelRequired within parentExpand List policies — 200 response body — policies item policy allowance proration
Proration configuration for policy allowances
policy_allowancesarrayRequired within parentAllowances associated with this policy
policy_allowances[]ModelEach itemExpand List policies — 200 response body — policies item policy allowances item
policy_typeModelRequired within parentExpand List policies — 200 response body — policies item policy type
Type of this policy
policy_type_idstringOptionalUnique identifier of the policy type
Format: uuid
request_start_typeJSONRequired within parentType of request start configuration
request_start_type (anyOf 1)stringAlternativeType of request start configuration
Known values: IMMEDIATELY, FIXED_PERIOD
request_start_type (anyOf 2)nullAlternative
request_start_unitJSONRequired within parentUnit used for request start configuration
request_start_unit (anyOf 1)stringAlternativeUnit used for request start configuration
Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR
request_start_unit (anyOf 2)nullAlternative
request_start_unit_amountJSONRequired within parent
request_start_unit_amount (anyOf 1)JSONAlternative
request_start_unit_amount (anyOf 1) (anyOf 1)numberAlternativeAmount of request start units
Format: double
request_start_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
request_start_unit_amount (anyOf 2)nullAlternativeAmount of request start units
Format: double
retrospective_request_typestringRequired within parentType of retrospective requests allowed
Known values: ALLOWED, NOT_ALLOWED
time_off_request_typestringRequired within parentType of time off requests allowed
Known values: HALF_DAY, HOURLY, FULL_DAY, PERCENTAGE, PARTIAL_HOURS
time_off_typesarrayOptionalTime off types associated with this policy
time_off_types[]ModelEach itemExpand List policies — 200 response body — policies item time off types item
tracking_cadencestringOptionalCadence for tracking policy periods
Known values: FIXED_DAY, ANNIVERSARY, NOT_SPECIFIED
tracking_start_dateJSONOptional
tracking_start_date (anyOf 1)stringAlternativeStart date for tracking policy periods
Format: date
tracking_start_date (anyOf 2)nullAlternativeStart date for tracking policy periods
Format: date
tracking_unitJSONRequired within parentUnit used for tracking policy periods
tracking_unit (anyOf 1)stringAlternativeUnit used for tracking policy periods
Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR
tracking_unit (anyOf 2)nullAlternative
tracking_unit_amountJSONRequired within parent
tracking_unit_amount (anyOf 1)JSONAlternative
tracking_unit_amount (anyOf 1) (anyOf 1)numberAlternativeAmount of tracking units
Format: double
tracking_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tracking_unit_amount (anyOf 2)nullAlternativeAmount of tracking units
Format: double
updated_atstringRequired within parentDate and time when the policy was last updated
Format: date-time

Referenced models: Validate time-off request — 200 response body — data custom fields item, List policies — 200 response body — policies item policy allowance proration, List policies — 200 response body — policies item policy allowances item, List policies — 200 response body — policies item policy type, List policies — 200 response body — policies item time off types item

List policies — 200 response body — policies item policy type
FieldTypePresenceDescription and constraints
$objectRootType of this policy
idstringRequired within parentUnique identifier of the policy type
Format: uuid
namestringRequired within parentName of the policy type
List policies — 200 response body — policies item time off types item
FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the time off type
description (anyOf 2)nullAlternativeDescription of the time off type
idstringOptionalUnique identifier of the time off type
Format: uuid
namestringOptionalName of the time off type

SDK function policy ID: deel.timeoff_gettimeoffpolicies. Catalog operation: timeoff_gettimeoffpolicies. 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-01-01"}

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.