Skip to content

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.

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 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.list_time_off_requests_for_organization(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.statusarrayOptional
query.status[]stringEach itemOne of: REQUESTED, APPROVED, REJECTED, USED, CANCELED, DELETED
query.time_off_idsarrayOptional
query.time_off_ids[]stringEach itemFormat: uuid
query.start_datestringOptionalFormat: date-time
query.end_datestringOptionalFormat: date-time
query.approval_start_datestringOptionalFormat: date-time
query.approval_end_datestringOptionalFormat: date-time
query.updated_start_datestringOptionalFormat: date-time
query.updated_end_datestringOptionalFormat: date-time
query.page_sizeintegerOptionalMaximum: 200
Minimum: 5
query.policy_typesarrayOptional
query.policy_types[]stringEach itemFormat: uuid
query.policy_type_namesarrayOptional
query.policy_type_names[]ModelEach itemExpand List policies — request body — query policy type name
query.nextstringOptional
query.include_deleted_time_offsbooleanOptionalDefault: false

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 time-off requests for Organization — 200 response body

Referenced models: List time-off requests for Organization — 200 response body

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

List time-off requests for Organization — 200 response body
FieldTypePresenceDescription and constraints
$objectRootTime offs associated to the query
countJSONOptional
count (anyOf 1)integerAlternativeTotal count of items
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dataarrayRequired within parent
data[]ModelEach itemExpand List time-off requests for Organization — 200 response body — data item
has_next_pagebooleanRequired within parentHas next page
nextstringOptional
page_sizeJSONRequired within parent
page_size (anyOf 1)integerAlternativePage size
Maximum: 200
Minimum: 5
page_size (anyOf 2)stringAlternativePattern: ^-?[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
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 time-off requests for Organization — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentAmount of time off
approved_atJSONOptional
approved_at (anyOf 1)stringAlternativeTime off approval date
Format: date-time
approved_at (anyOf 2)nullAlternativeTime off approval date
Format: date-time
canceled_atJSONOptional
canceled_at (anyOf 1)stringAlternativeTime off cancellation date
Format: date-time
canceled_at (anyOf 2)nullAlternativeTime off cancellation date
Format: date-time
contract_oidstringOptionalContract id
created_atstringRequired within parentTime off creation date
Format: date-time
custom_field_valuesarrayOptionalAnswers to the custom fields the request policy declares. Omitted when the policy declares none.
custom_field_values[]ModelEach itemExpand Update time-off request — 200 response body — time off custom field values item
deduction_amountJSONOptional
deduction_amount (anyOf 1)stringAlternativeDeduction amount
deduction_amount (anyOf 2)nullAlternativeDeduction amount
deleted_atJSONOptional
deleted_at (anyOf 1)stringAlternativeTime 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)nullAlternativeTime off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested.
Format: date-time
descriptionJSONOptional
description (anyOf 1)stringAlternativeTime off description
description (anyOf 2)nullAlternativeTime off description
end_datestringRequired within parentEnd date of time off
Format: date
entitlement_unitstringRequired within parentThe unit in which the time off usage and entitlement are calculated.
Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR
half_end_datebooleanRequired within parentIs half end date
half_start_datebooleanRequired within parentIs half start date
idstringRequired within parentTime off id
Format: uuid
is_end_date_estimatedbooleanOptionalIs end date estimated
is_paidbooleanRequired within parentIs time off paid
other_type_descriptionJSONOptional
other_type_description (anyOf 1)stringAlternativeOther type description
other_type_description (anyOf 2)nullAlternativeOther type description
reasonstringOptionalReason for time off
recipient_profileModelOptionalExpand List time-off requests — 200 response body — data item recipient profile
requested_atstringRequired within parentTime off request date
Format: date
requester_profileModelOptionalExpand List time-off requests — 200 response body — data item requester profile
start_datestringRequired within parentStart date of time off
Format: date
statusstringOptionalStatus of time off
Known values: REQUESTED, APPROVED, REJECTED, USED, CANCELED, DELETED
time_off_dailiesarrayOptional
time_off_dailies[]ModelEach itemExpand List time-off requests — 200 response body — data item time off dailies item
time_off_originstringOptionalTime 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_percentageJSONOptional
time_off_percentage (anyOf 1)stringAlternativeTime off percentage
time_off_percentage (anyOf 2)nullAlternativeTime off percentage
time_off_typeModelOptionalExpand List time-off requests for Organization — 200 response body — data item time off type
time_off_type_idstringRequired within parentTime off type id
updated_atstringRequired within parentTime 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
FieldTypePresenceDescription and constraints
$objectRoot
field_idstringRequired within parentThe id of the custom field this value answers.
Format: uuid
valueJSONRequired within parent
value (anyOf 1)stringAlternativeThe submitted value for the custom field, serialized as text. When no value is provided, this will be null.
value (anyOf 2)nullAlternativeThe 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
FieldTypePresenceDescription and constraints
$objectRoot
client_profile_idstringOptionalRecipient client profile id
Format: uuid
hris_profile_idstringOptionalRecipient hris profile id
Format: uuid
organization_idstringOptionalRecipient organization id
Format: uuid
List time-off requests — 200 response body — data item requester profile
FieldTypePresenceDescription and constraints
$objectRoot
client_profile_idstringOptionalRequest client profile id
Format: uuid
hris_profile_idstringOptionalRequest hris profile id
Format: uuid
organization_idstringOptionalRequest organization id
Format: uuid
List time-off requests — 200 response body — data item time off dailies item
FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentTime off daily amount
created_atstringRequired within parentTime off daily creation date
Format: date-time
datestringRequired within parentTime off daily date
Format: date
descriptionJSONOptional
description (anyOf 1)stringAlternativeTime off daily description
description (anyOf 2)nullAlternativeTime off daily description
idstringRequired within parentTime off daily id
Format: uuid
time_off_idstringRequired within parentTime off id
Format: uuid
typestringRequired within parentTime off daily type
Known values: WORKING_DAY, NON_WORKING_DAY, HOLIDAY, FORFAIT_HOUR_DAY
updated_atstringRequired within parentTime off daily update date
Format: date-time

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

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.