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.
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"]["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 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_time_off_policies(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.hris_profile_id | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.policy_type_name | Model | Optional | Expand List policies — request body — query policy type name |
query.policy_type_id | string | Optional | Format: uuid |
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 List policies — 200 response body |
Referenced models: List policies — 200 response body
Schemas
Section titled “Schemas”5 more schemas are linked from the tables above, on the schema pages.
List policies — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
policies | array | Optional | |
policies[] | Model | Each item | Expand List policies — 200 response body — policies item |
Referenced models: List policies — 200 response body — policies 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 |
List policies — 200 response body — policies item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time off policy |
allow_to_edit_past_time_offs | boolean | Required within parent | Whether editing past time offs is allowed |
auto_approval_inactivity_time_unit | JSON | Required within parent | Unit for auto-approval inactivity time |
auto_approval_inactivity_time_unit (anyOf 1) | string | Alternative | Unit for auto-approval inactivity time Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
auto_approval_inactivity_time_unit (anyOf 2) | null | Alternative | |
auto_approval_inactivity_time_unit_amount | JSON | Required within parent | |
auto_approval_inactivity_time_unit_amount (anyOf 1) | JSON | Alternative | |
auto_approval_inactivity_time_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of auto-approval inactivity time units Format: double |
auto_approval_inactivity_time_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
auto_approval_inactivity_time_unit_amount (anyOf 2) | null | Alternative | Amount of auto-approval inactivity time units Format: double |
created_at | string | Required within parent | Date and time 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 | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the policy |
description (anyOf 2) | null | Alternative | Description of the policy |
has_custom_fields | boolean | Required within parent | Whether the policy collects any custom field answers on its requests. |
id | string | Required within parent | Unique identifier of the policy Format: uuid |
is_attachment_required | string | Required within parent | Whether an attachment is required for time off requests Known values: NOT_REQUIRED, REQUIRED, CONDITIONALLY_REQUIRED |
is_description_required | boolean | Required within parent | Whether a description is required for time off requests |
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 for this policy Known values: SHORT_TERM_LEAVE, LONG_TERM_LEAVE |
name | string | Required within parent | Name of the policy |
notice_period_unit | JSON | Required within parent | Unit for notice period |
notice_period_unit (anyOf 1) | string | Alternative | Unit for notice period Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
notice_period_unit (anyOf 2) | null | Alternative | |
notice_period_unit_amount | JSON | Required within parent | |
notice_period_unit_amount (anyOf 1) | JSON | Alternative | |
notice_period_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of notice period units Format: double |
notice_period_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
notice_period_unit_amount (anyOf 2) | null | Alternative | Amount of notice period units Format: double |
overlap_request_type | string | Required within parent | Type of overlapping requests allowed Known values: ALLOWED, NOT_ALLOWED |
payment_type | string | Required within parent | Payment type for the time off policy Known values: PAID, UNPAID |
policy_allowance_proration | Model | Required within parent | Expand List policies — 200 response body — policies item policy allowance proration Proration configuration for policy allowances |
policy_allowances | array | Required within parent | Allowances associated with this policy |
policy_allowances[] | Model | Each item | Expand List policies — 200 response body — policies item policy allowances item |
policy_type | Model | Required within parent | Expand List policies — 200 response body — policies item policy type Type of this policy |
policy_type_id | string | Optional | Unique identifier of the policy type Format: uuid |
request_start_type | JSON | Required within parent | Type of request start configuration |
request_start_type (anyOf 1) | string | Alternative | Type of request start configuration Known values: IMMEDIATELY, FIXED_PERIOD |
request_start_type (anyOf 2) | null | Alternative | |
request_start_unit | JSON | Required within parent | Unit used for request start configuration |
request_start_unit (anyOf 1) | string | Alternative | Unit used for request start configuration Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
request_start_unit (anyOf 2) | null | Alternative | |
request_start_unit_amount | JSON | Required within parent | |
request_start_unit_amount (anyOf 1) | JSON | Alternative | |
request_start_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of request start units Format: double |
request_start_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
request_start_unit_amount (anyOf 2) | null | Alternative | Amount of request start units Format: double |
retrospective_request_type | string | Required within parent | Type of retrospective requests allowed Known values: ALLOWED, NOT_ALLOWED |
time_off_request_type | string | Required within parent | Type of time off requests allowed Known values: HALF_DAY, HOURLY, FULL_DAY, PERCENTAGE, PARTIAL_HOURS |
time_off_types | array | Optional | Time off types associated with this policy |
time_off_types[] | Model | Each item | Expand List policies — 200 response body — policies item time off types item |
tracking_cadence | string | Optional | Cadence for tracking policy periods Known values: FIXED_DAY, ANNIVERSARY, NOT_SPECIFIED |
tracking_start_date | JSON | Optional | |
tracking_start_date (anyOf 1) | string | Alternative | Start date for tracking policy periods Format: date |
tracking_start_date (anyOf 2) | null | Alternative | Start date for tracking policy periods Format: date |
tracking_unit | JSON | Required within parent | Unit used for tracking policy periods |
tracking_unit (anyOf 1) | string | Alternative | Unit used for tracking policy periods Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
tracking_unit (anyOf 2) | null | Alternative | |
tracking_unit_amount | JSON | Required within parent | |
tracking_unit_amount (anyOf 1) | JSON | Alternative | |
tracking_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of tracking units Format: double |
tracking_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tracking_unit_amount (anyOf 2) | null | Alternative | Amount of tracking units Format: double |
updated_at | string | Required within parent | Date 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Type of this policy |
id | string | Required within parent | Unique identifier of the policy type Format: uuid |
name | string | Required within parent | Name of the policy type |
List policies — 200 response body — policies item time off types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the time off type |
description (anyOf 2) | null | Alternative | Description of the time off type |
id | string | Optional | Unique identifier of the time off type Format: uuid |
name | string | Optional | Name of the time off type |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}