Skip to content

Deel: Get Work Schedule and Holidays

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

← Time off operations · Get started

Operation deel.timeoff_gettimeoffdailies

Provider route: GET /time_offs/dailies. 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"]["getTimeOffDailies"]>[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.getTimeOffDailies(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_dailies(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.start_datestringOptionalFormat: date
query.end_datestringOptionalFormat: date
query.hris_profile_idsarrayOptional
query.hris_profile_ids[]stringEach itemFormat: uuid
query.countriesarrayOptional
query.countries[]stringEach itemMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Work Schedule and Holidays — 200 response body

Referenced models: Get Work Schedule and Holidays — 200 response body

Get Work Schedule and Holidays — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptionalList of holiday and work schedule information grouped by HRIS profile, including holidays within the date range, work schedule details, and daily work status
data[]ModelEach itemExpand Get Work Schedule and Holidays — 200 response body — data item

Referenced models: Get Work Schedule and Holidays — 200 response body — data item

Get Work Schedule and Holidays — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
holidaysarrayRequired within parentList of holidays within the date range
holidays[]ModelEach itemExpand Get Work Schedule and Holidays — 200 response body — data item holidays item
time_off_dailiesarrayRequired within parentList of days with holiday or work status
time_off_dailies[]ModelEach itemExpand Get Work Schedule and Holidays — 200 response body — data item time off dailies item
work_scheduleModelRequired within parentExpand Get Work Schedule and Holidays — 200 response body — data item work schedule
Detail of working hours by week day for an HRIS profile

Referenced models: Get Work Schedule and Holidays — 200 response body — data item holidays item, Get Work Schedule and Holidays — 200 response body — data item time off dailies item, Get Work Schedule and Holidays — 200 response body — data item work schedule

Get Work Schedule and Holidays — 200 response body — data item holidays item
FieldTypePresenceDescription and constraints
$objectRoot
countrystringOptionalThe ISO 3166-1 alpha-2 country code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
created_by_profile_idJSONOptional
created_by_profile_id (anyOf 1)JSONAlternative
created_by_profile_id (anyOf 1) (anyOf 1)numberAlternativeHRIS profile id of the creator of the holiday
Format: double
created_by_profile_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_by_profile_id (anyOf 2)nullAlternativeHRIS profile id of the creator of the holiday
Format: double
datestringRequired within parentDate of the holiday
Format: date-time
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the holiday
description (anyOf 2)nullAlternativeDescription of the holiday
formatted_datestringRequired within parentFormatted 'YYYY-MM-DD' date of the holiday
Format: date
is_every_yearbooleanRequired within parentSets if the holiday is a recurring event
is_mandatorybooleanRequired within parentDescribes if the holiday is mandatory
namestringRequired within parentName of the holiday
name_variationsarrayOptionalAlternative names or labels used to refer to this holiday
name_variations[]stringEach item
parsed_datestringOptionalParsed date time of the holiday
Format: date-time
sourceJSONRequired within parentSource of creation of the holiday
source (anyOf 1)stringAlternativeSource of creation of the holiday
Known values: EXTERNAL, DEEL, ORGANIZATION_CUSTOM, ORGANIZATION_OVERRIDE, ORGANIZATION_CONVERT
source (anyOf 2)nullAlternative
statesarrayOptionalList of states where the holiday is celebrated, if empty it is a country holiday
states[]stringEach item
typestringRequired within parentType of the holiday
Known values: MANDATORY, OPTIONAL, HIDDEN, HOLIDAY, WORKING_DAY
Get Work Schedule and Holidays — 200 response body — data item time off dailies item
FieldTypePresenceDescription and constraints
$objectRoot
datestringRequired within parentDate of the daily
Format: date
time_off_daily_typestringRequired within parentType of work status or holiday
Known values: HOLIDAY, WORKING_DAY, NON_WORKING_DAY
Get Work Schedule and Holidays — 200 response body — data item work schedule
FieldTypePresenceDescription and constraints
$objectRootDetail of working hours by week day for an HRIS profile
hours_per_dayJSONOptional
hours_per_day (anyOf 1)numberAlternativeWorking hours per day
Format: double
Maximum: 24
Minimum: 0
hours_per_day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hris_profile_idstringOptionalHRIS profile id
Format: uuid
work_weekModelOptionalExpand Get Work Schedule and Holidays — 200 response body — data item work schedule work week
The work week schedule for the HRIS profile

Referenced models: Get Work Schedule and Holidays — 200 response body — data item work schedule work week

Get Work Schedule and Holidays — 200 response body — data item work schedule work week
FieldTypePresenceDescription and constraints
$objectRootThe work week schedule for the HRIS profile
fridayJSONRequired within parent
friday (anyOf 1)numberAlternativeWorking hours on friday
Format: double
Maximum: 24
Minimum: 0
friday (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
mondayJSONRequired within parent
monday (anyOf 1)numberAlternativeWorking hours on monday
Format: double
Maximum: 24
Minimum: 0
monday (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
saturdayJSONRequired within parent
saturday (anyOf 1)numberAlternativeWorking hours on saturday
Format: double
Maximum: 24
Minimum: 0
saturday (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sundayJSONRequired within parent
sunday (anyOf 1)numberAlternativeWorking hours on sunday
Format: double
Maximum: 24
Minimum: 0
sunday (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thursdayJSONRequired within parent
thursday (anyOf 1)numberAlternativeWorking hours on thursday
Format: double
Maximum: 24
Minimum: 0
thursday (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tuesdayJSONRequired within parent
tuesday (anyOf 1)numberAlternativeWorking hours on tuesday
Format: double
Maximum: 24
Minimum: 0
tuesday (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
wednesdayJSONRequired within parent
wednesday (anyOf 1)numberAlternativeWorking hours on wednesday
Format: double
Maximum: 24
Minimum: 0
wednesday (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: deel.timeoff_gettimeoffdailies. Catalog operation: timeoff_gettimeoffdailies. 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.