Deel: List time-off requests for Organization
Deel timeOff.listTimeOffRequestsForOrganization: arguments, response, policy and SDK examples.
← Time off operations · Get started
Operation deel.timeoff_listtimeoffrequestsfororganization_v2026_01_01
Provider route: GET /time_offs. 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"]["listTimeOffRequestsForOrganization"]>[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.listTimeOffRequestsForOrganization(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.list_time_off_requests_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.status | array | Optional | |
query.status[] | string | Each item | One of: REQUESTED, APPROVED, REJECTED, USED, CANCELED, DELETED |
query.time_off_ids | array | Optional | |
query.time_off_ids[] | string | Each item | Format: uuid |
query.start_date | string | Optional | Format: date-time |
query.end_date | string | Optional | Format: date-time |
query.approval_start_date | string | Optional | Format: date-time |
query.approval_end_date | string | Optional | Format: date-time |
query.updated_start_date | string | Optional | Format: date-time |
query.updated_end_date | string | Optional | Format: date-time |
query.page_size | integer | Optional | Maximum: 200 Minimum: 5 |
query.policy_types | array | Optional | |
query.policy_types[] | string | Each item | Format: uuid |
query.policy_type_names | array | Optional | |
query.policy_type_names[] | Model | Each item | Expand List policies — request body — query policy type name |
query.next | string | Optional | |
query.include_deleted_time_offs | boolean | Optional | Default: false |
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 time-off requests for Organization — 200 response body |
Referenced models: List time-off requests for Organization — 200 response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
List time-off requests for Organization — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time offs associated to the query |
count | JSON | Optional | |
count (anyOf 1) | integer | Alternative | Total count of items |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
data | array | Required within parent | |
data[] | Model | Each item | Expand List time-off requests for Organization — 200 response body — data item |
has_next_page | boolean | Required within parent | Has next page |
next | string | Optional | |
page_size | JSON | Required within parent | |
page_size (anyOf 1) | integer | Alternative | Page size Maximum: 200 Minimum: 5 |
page_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List time-off requests 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 |
List time-off requests for Organization — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Amount of time off |
approved_at | JSON | Optional | |
approved_at (anyOf 1) | string | Alternative | Time off approval date Format: date-time |
approved_at (anyOf 2) | null | Alternative | Time off approval date Format: date-time |
canceled_at | JSON | Optional | |
canceled_at (anyOf 1) | string | Alternative | Time off cancellation date Format: date-time |
canceled_at (anyOf 2) | null | Alternative | Time off cancellation date Format: date-time |
contract_oid | string | Optional | Contract id |
created_at | string | Required within parent | Time off creation date Format: date-time |
custom_field_values | array | Optional | Answers to the custom fields the request policy declares. Omitted when the policy declares none. |
custom_field_values[] | Model | Each item | Expand Update time-off request — 200 response body — time off custom field values item |
deduction_amount | JSON | Optional | |
deduction_amount (anyOf 1) | string | Alternative | Deduction amount |
deduction_amount (anyOf 2) | null | Alternative | Deduction amount |
deleted_at | JSON | Optional | |
deleted_at (anyOf 1) | string | Alternative | Time off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested. Format: date-time |
deleted_at (anyOf 2) | null | Alternative | Time off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested. Format: date-time |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Time off description |
description (anyOf 2) | null | Alternative | Time off description |
end_date | string | Required within parent | End date of time off Format: date |
entitlement_unit | string | Required within parent | The unit in which the time off usage and entitlement are calculated. Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
half_end_date | boolean | Required within parent | Is half end date |
half_start_date | boolean | Required within parent | Is half start date |
id | string | Required within parent | Time off id Format: uuid |
is_end_date_estimated | boolean | Optional | Is end date estimated |
is_paid | boolean | Required within parent | Is time off paid |
other_type_description | JSON | Optional | |
other_type_description (anyOf 1) | string | Alternative | Other type description |
other_type_description (anyOf 2) | null | Alternative | Other type description |
reason | string | Optional | Reason for time off |
recipient_profile | Model | Optional | Expand List time-off requests — 200 response body — data item recipient profile |
requested_at | string | Required within parent | Time off request date Format: date |
requester_profile | Model | Optional | Expand List time-off requests — 200 response body — data item requester profile |
start_date | string | Required within parent | Start date of time off Format: date |
status | string | Optional | Status of time off Known values: REQUESTED, APPROVED, REJECTED, USED, CANCELED, DELETED |
time_off_dailies | array | Optional | |
time_off_dailies[] | Model | Each item | Expand List time-off requests — 200 response body — data item time off dailies item |
time_off_origin | string | Optional | Time off origin. AUTO_BANK_HOLIDAY is a bank holiday request that the system books for the worker. Known values: ADMIN, BULK_IMPORT, DEEL_APP, ENGAGE, INTEGRATION, PUBLIC_API, SLACK, TEAMS, AUTO_BANK_HOLIDAY, UNKNOWN |
time_off_percentage | JSON | Optional | |
time_off_percentage (anyOf 1) | string | Alternative | Time off percentage |
time_off_percentage (anyOf 2) | null | Alternative | Time off percentage |
time_off_type | Model | Optional | Expand List time-off requests for Organization — 200 response body — data item time off type |
time_off_type_id | string | Required within parent | Time off type id |
updated_at | string | Required within parent | Time off update date Format: date-time |
Referenced models: Update time-off request — 200 response body — time off custom field values item, List time-off requests — 200 response body — data item recipient profile, List time-off requests — 200 response body — data item requester profile, List time-off requests — 200 response body — data item time off dailies item, List time-off requests for Organization — 200 response body — data item time off type
Update time-off request — 200 response body — time off custom field values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_id | string | Required within parent | The id of the custom field this value answers. Format: uuid |
value | JSON | Required within parent | |
value (anyOf 1) | string | Alternative | The submitted value for the custom field, serialized as text. When no value is provided, this will be null. |
value (anyOf 2) | null | Alternative | The submitted value for the custom field, serialized as text. When no value is provided, this will be null. |
List time-off requests — 200 response body — data item recipient profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_profile_id | string | Optional | Recipient client profile id Format: uuid |
hris_profile_id | string | Optional | Recipient hris profile id Format: uuid |
organization_id | string | Optional | Recipient organization id Format: uuid |
List time-off requests — 200 response body — data item requester profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_profile_id | string | Optional | Request client profile id Format: uuid |
hris_profile_id | string | Optional | Request hris profile id Format: uuid |
organization_id | string | Optional | Request organization id Format: uuid |
List time-off requests — 200 response body — data item time off dailies item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Time off daily amount |
created_at | string | Required within parent | Time off daily creation date Format: date-time |
date | string | Required within parent | Time off daily date Format: date |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Time off daily description |
description (anyOf 2) | null | Alternative | Time off daily description |
id | string | Required within parent | Time off daily id Format: uuid |
time_off_id | string | Required within parent | Time off id Format: uuid |
type | string | Required within parent | Time off daily type Known values: WORKING_DAY, NON_WORKING_DAY, HOLIDAY, FORFAIT_HOUR_DAY |
updated_at | string | Required within parent | Time off daily update date Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.timeoff_listtimeoffrequestsfororganization_v2026_01_01. Catalog operation: timeoff_listtimeoffrequestsfororganization_v2026_01_01. 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"}