Deel Subpackage Time Off API
The subpackage_timeOff API from Deel — 11 operation(s) for subpackage_timeoff.
Deel Subpackage Time Off API is one of 128 APIs that Deel publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include subpackage_timeOff. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 13 operations across 11 paths, and defines 237 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.letsdeel.com/rest/v2, https://api-staging.letsdeel.com/rest/v2.
13 operations
11 paths
237 schemas
1 DELETE7 GET1 PATCH4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Deel Subpackage Time Off API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (deelToken).
It accepts HTTP bearer tokens (oauth2).
deelToken— Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authenticatio…oauth2— Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/
Paths & Operations 13
Across 11 paths, the API surfaces 13 operations — 1 DELETE, 7 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
subpackage_timeOff 13
POST
/time_offs/review
Approve/Reject time-off requests
DELETE
/time_offs/{time_off_id}
Cancel time-off request
PATCH
/time_offs/{time_off_id}
Update time-off request
POST
/time_offs
Create time-off request
GET
/time_offs
List time-off requests for Organization
POST
/time_offs/global-payroll/sync
External HR Time Off Synchronization
GET
/time_offs/profile/{hris_profile_id}/entitlements
Get Profile Entitlements
GET
/time_offs/time-off-events
Get Time Off Events for Profile
GET
/time_offs/dailies
Get Work Schedule and Holidays
GET
/time_offs/profile/{hris_profile_id}/policies
List policies
GET
/time_offs/profile/{hris_profile_id}
List time-off requests
GET
/time_offs/policy-validation-templates
Retrieve policy validation templates
POST
/time_offs/validate
Validate time-off request
Schemas 237
The contract defines 237 schemas that model the data the API accepts and returns. The most detailed are TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItems (56 properties), TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItems (29 properties), TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItems (26 properties), TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOff (26 properties). Each schema is shown below with its type and property counts.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRequesterProfile
object
The time off profile of the requester of the time off request. Can be either a client or worker profile.
3 properties
1 required
TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItems
object
2 properties
2 required
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffAttachmentsItems
object
An attachment associated with the time off request.
4 properties
4 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualType
string
Type of accrual for the allowance. Determines how/when profiles should earn their entitlement (aka: allowance).
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItems
object
8 properties
7 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDate
object
The adoption-date of the child. Might be required depending on the type if leave requests.
2 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyValidationTemplateRemindersItems
object
UpdateTimeOffRequestRequestBadRequestError
object
2 properties
TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItemsEventDetails
object
Details of the time off event
6 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualApplicationType
string
Type of accrual application. Enum to indicate when accruals will be applied within the accrual cycles.
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsType
string
Type of the policy allowance
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItems
object
Time off policy
29 properties
24 required
GetTimeOffEventsForProfileRequestBadRequestError
object
2 properties
TimeOffsProfileHrisProfileIdPoliciesGetParametersPolicyTypeName
string
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItems
object
3 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartType
string
When the entitlement starts.
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItemsAmount
TimeOffsValidatePostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementExpirationUnit
string
Unit used for entitlement expiration
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventType
string
The type of the time off event.
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingUnit
string
Unit used for tracking policy periods
TimeOffsPostResponsesContentApplicationJsonSchemaErrors
object
Error details
1 property
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsLeaveType
string
Classification of the leave duration.
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicy
object
13 properties
4 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsData
object
3 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualUnit
string
Unit used for accrual
TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEndDate
End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentCondition
string
Comparison operator if attachment is conditionally required.
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDate
object
The birth-date of the child. Required for parental leave requests.
2 properties
2 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDateType
string
The type of the field, indicating it is a date-only field
TimeOffsGetParametersStatusSchemaItems
string
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyTypesItems
object
3 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingCadence
string
Cadence for tracking policy periods
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems1
object
3 properties
3 required
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems
object
8 properties
7 required
TimeOffsReviewPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOff
object
Used to return the updated time off request after modification. Contains all the time off details including status, dates, amounts, and associated metadata.
26 properties
11 required
TimeOffsPostRequestBodyContentApplicationJsonSchemaData
object
The time off request data
16 properties
3 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAdditionalAllowanceRulesItems
object
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems
object
8 properties
7 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyType
object
Details of the associated policy type.
3 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartUnit
string
Unit used for request start configuration
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItems
object
Result of a specific country validation rule
4 properties
1 required
TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStartDate
Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first da…
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRequesterProfile
object
The time off profile of the requester of the time off request. Can be either a client or worker profile.
3 properties
1 required
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRecipientProfile
object
The time off profile of the recipient of the time off request. Must be a worker profile.
2 properties
2 required
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsSource
string
Source of creation of the holiday
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicy
object
3 properties
3 required
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsAccrualUnit
string
Accrual unit
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsType
string
The type of day for the time off request. All dates must follow the same type.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationTerminationProrationRule
string
Rule for prorating entitlement upon termination.
CreateTimeOffRequest-v2026-01-01RequestForbiddenError
object
2 properties
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItems
object
The dates breakdown for the time off request.
4 properties
1 required
time-off_getTimeOffEvents_Response_200
object
List of time off events for the profile
1 property
1 required
TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDate
An specific date in the time-off request
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsStatus
string
Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED.
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffType
object
The type of time off taken.
3 properties
2 required
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItems
object
13 properties
8 required
time-off_getTimeOffDailies_Response_200
object
1 property
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffEntitlementUnit
string
The unit in which the time off usage and entitlement are calculated.
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsAutoApprovalInactivityTimeUnit
string
Unit for auto-approval inactivity time
time-off_getTimeOffProfile_Response_200
object
Time offs associated to the query
4 properties
3 required
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaData
object
1 property
1 required
TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEventDetails
object
Details of the event associated with the time off request. Required for event based policies such as parental leave.
4 properties
3 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsNoticePeriodUnit
string
Unit for notice period
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffTypesItems
object
3 properties
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItems
object
14 properties
8 required
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataStartDate
Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first da…
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventType
string
The type of the time off event.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingCadence
string
Determines when the tracking cycle starts.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualType
string
How entitlement accrues (over time or based on events).
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
Status of time off
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverType
string
Type of rollover
time-off_createTimeOffRequest_Response_201
object
The list of created time offs. Depending on the selected dates, a time off can be split into more than one request.
1 property
1 required
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEndDate
End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.
TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaRequest
object
7 properties
TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaRequest
object
7 properties
time-off_getTimeOffPolicyValidationTemplates_Response_200
object
1 property
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffRequestType
string
Allowed types of time off requests (e.g., full day, hourly).
TimeOffsValidatePostResponsesContentApplicationJsonSchemaRequest
object
7 properties
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItemsType
string
Event type
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItems
object
56 properties
CreateTimeOffRequest-v2026-01-01RequestNotFoundError
object
2 properties
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType
string
Time off daily type
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
Status of time off
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsTerminationType
string
Rule for handling the balance upon termination.
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems
object
24 properties
12 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsIsAttachmentRequired
string
Whether an attachment is required for time off requests
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventEventDetails
object
Details of the event associated with the time off request. Required for event based policies such as parental leave.
6 properties
2 required
ListPoliciesRequestNotFoundError
object
1 property
time-off_reviewTimeOffRequest_Response_201
object
The response contains two lists: one for time-offs that were successfully reviewed and another for those that could not be reviewed. Each time-off in the revie…
1 property
1 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAdoptionDateDefinition
string
Rule regarding the requirement of an adoption date for relevant policies.
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile
object
3 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingUnit
string
The unit used for tracking the policy cycle (e.g., yearly).
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaRequest
object
Request metadata
6 properties
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItemsType
string
Event type
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirth
object
Indicates if the child was born prematurely. Required for parental leave requests.
2 properties
2 required
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile
object
3 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverExpirationUnit
string
Unit used for rollover expiration
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItems
object
14 properties
8 required
TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataNotReviewedItems
object
2 properties
2 required
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicyPolicyType
object
2 properties
2 required
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0PolicyType
string
The Deel policy type of the policy the time off is being requested for.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaRequest
object
7 properties
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirthType
string
The type of the field, indicating it is a boolean field
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0EntitlementUnit
string
The time unit for this time off. Mandatory when amount parameter is informed. If no amount and no entitlementunit are informed, it will be calculated using Dee…
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAutoApprovalInactivityTimeUnit
string
Unit for the auto-approval inactivity period.
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFields
object
Fields required for specific time off requests, such as parental leave.
4 properties
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItems
object
22 properties
5 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementUnit
string
Unit used for entitlement
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartUnit
string
Unit for the waiting period if requeststarttype is FIXEDPERIOD.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRetrospectiveRequestType
string
Rule for requesting time off for past dates.
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItems
object
Result of a specific country validation rule
4 properties
1 required
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItemsType
string
Type of the time off daily. Can be WORKINGDAY, NONWORKINGDAY or HOLIDAY.
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkSchedule
object
Detail of working hours by week day for an HRIS profile
3 properties
ValidateTimeOffRequest-v2026-01-01RequestBadRequestError
object
2 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsUploadAttachmentCondition
string
Condition under which an attachment is needed for a request.
RetrievePolicyValidationTemplatesRequestBadRequestError
object
2 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverExpirationUnit
string
Unit for the expiration period of rolled-over balance.
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsAttachmentsItems
object
An attachment associated with the time off request.
4 properties
4 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItems
object
23 properties
22 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsLeaveType
string
Type of leave for this policy
TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItems
object
The dates breakdown for the time off request.
4 properties
1 required
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPaymentType
string
Payment type for the time off policy
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffTypeValidationsItems
object
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType
string
The type of day for the time off request. All dates must follow the same type.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualApplicationType
string
When the accrued amount is applied to the balance.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementUnit
string
Unit in which the entitlement is measured.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartType
string
When a worker can start requesting time off after becoming eligible.
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType
string
Time off daily type
time-off_getTimeOffPolicies_Response_200
object
1 property
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsOverlapRequestType
string
Type of overlapping requests allowed
TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStatus
string
Status for the time off request. When set to REQUESTED the time off should be reviewed later through the Approve/Reject time off api.
ApproveRejectTimeOffRequests-v2026-01-01RequestBadRequestError
object
2 properties
TimeOffsPostResponsesContentApplicationJsonSchemaRequest
object
Request metadata
6 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItems
object
26 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualUnit
string
Unit for accrual if type is TIMEFRAME.
CreateTimeOffRequest-v2026-01-01RequestBadRequestError
object
2 properties
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyLeaveType
string
Leave type
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRetrospectiveRequestType
string
Type of retrospective requests allowed
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsType
string
Type of allowance (base or additional).
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTimeOffTypesItems
object
2 properties
2 required
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems0
object
12 properties
5 required
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems
object
Date with holiday or work status by day
2 properties
2 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildrenType
string
The type of the field, indicating it is a boolean field
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventEventDetails
object
Details of the event associated with the time off request. Required for event based policies such as parental leave.
6 properties
2 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDateType
string
The type of the field, indicating it is a date-only field
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItems
object
7 properties
2 required
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffType
object
The type of time off taken.
3 properties
2 required
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicyPolicyType
object
2 properties
2 required
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsType
string
Type of the holiday
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEvent
object
8 properties
TimeOffsReviewPostResponsesContentApplicationJsonSchemaRequest
object
7 properties
time-off_getTimeOffEntitlements_Response_200
object
2 properties
2 required
GetWorkScheduleAndHolidaysRequestBadRequestError
object
2 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsBalanceTrackingType
string
Type of balance tracking. Determines how workers can request their time off.
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItems
object
3 properties
3 required
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsTimeOffDailyType
string
Type of work status or holiday
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsDayTypesItems
string
The type of leave for the day.
TimeOffsGetResponsesContentApplicationJsonSchemaDataItems
object
25 properties
12 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartUnit
string
Unit used for entitlement start
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile
object
3 properties
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEventDetails
object
Details of the event associated with the time off request. Required for event based policies such as parental leave.
5 properties
3 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaData
object
2 properties
TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaRequest
object
7 properties
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsEntitlementUnit
string
The unit in which the time off usage and entitlement are calculated.
ApiErrorContainer
object
2 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationHireProrationRule
string
Rule for prorating entitlement upon hiring.
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyPolicyType
object
2 properties
2 required
TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItems
object
Time off event object
8 properties
8 required
ApiErrorRequest
object
7 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType
string
How part-time workers are treated regarding entitlement.
TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType
string
The type of day for the time off request. All dates must follow the same type.
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsDataRangesItems
object
2 properties
1 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType
string
Type of treatment for part-time workers
TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItemsStatus
string
Decision on whether the time off request was approved or rejected
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsBenefitsPayerType
string
Who pays for the benefits associated with this time off.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProration
object
Proration rules applied to the policy allowances.
11 properties
TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType
string
The type of day for the time off request. All dates must follow the same type.
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit
string
The unit in which the time off usage and entitlement are calculated.
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsReviewPostResponsesContentApplicationJsonSchemaData
object
2 properties
2 required
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicy
object
The policy associated with the time off type.
3 properties
3 required
time-off_updateTimeOffRequest_Response_200
object
Time off data to be updated
1 property
1 required
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicy
object
The policy associated with the time off type.
3 properties
3 required
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffStatus
string
Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED.
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItems
object
Created time off request
26 properties
10 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffRequestType
string
Type of time off requests allowed
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsDataRangesItems
object
2 properties
1 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualProrateTypesItems
string
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsData
object
3 properties
ExternalHrTimeOffSynchronizationRequestBadRequestError
object
2 properties
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItemsType
string
Type of the time off daily. Can be WORKINGDAY, NONWORKINGDAY or HOLIDAY.
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicyPolicyType
object
2 properties
2 required
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEvent
object
8 properties
TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItems
object
The dates breakdown for the time off request.
4 properties
1 required
TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataEventDetails
object
Event details regarding the leave. Required for event based policies such as parental leave.
4 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverType
string
Rule for carrying over unused balance to the next cycle.
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProration
object
Proration configuration for policy allowances
4 properties
4 required
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkScheduleWorkWeek
object
The work week schedule for the HRIS profile
7 properties
7 required
TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItemsStatus
string
Time off status after review
time-off_validateTimeOff_Response_200
object
Time off request validation result
1 property
1 required
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDate
An specific date in the time-off request
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyType
object
Type of this policy
2 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsBalanceTrackingType
string
How the balance is tracked (e.g., flexible, inflexible).
ApiError
object
2 properties
TimeOffsProfileHrisProfileIdGetParametersStatusSchemaItems
string
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsNoticePeriodUnit
string
Unit for the required notice period.
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType
object
3 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsOverlapRequestType
string
Rule for requesting time off that overlaps with existing requests.
TimeOffsProfileHrisProfileIdEntitlementsGetParametersPolicyTypeName
string
Policy type name
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaData
object
Time off update request data
15 properties
3 required
TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItems
object
2 properties
2 required
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile
object
3 properties
Time_Off_listTimeOffRequestsForOrganization_Response_200
object
Time offs associated to the query
4 properties
3 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsPartTimeWorkerAdditionalAllowanceType
string
How additional allowances apply to part-time workers.
TimeOffsValidatePostResponsesContentApplicationJsonSchemaData
object
Time off request validation result
16 properties
1 required
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRecipientProfile
object
The time off profile of the recipient of the time off request. Must be a worker profile.
2 properties
2 required
TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaData
object
Time off request data
13 properties
3 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementExpirationUnit
string
Unit for entitlement expiration period.
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildren
object
Indicates if the request is for multiple children. Required for parental leave requests.
2 properties
2 required
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingCadence
string
Tracking cadence
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartType
string
Type of entitlement start
time-off_deleteTimeOffRequest_Response_204
object
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItems
object
8 properties
7 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartType
string
Type of request start configuration
time-off_syncTimeOffGlobalPayroll_Response_200
object
List of time offs persisted at Deel
1 property
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit
string
The unit in which the time off usage and entitlement are calculated.
TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaData
object
3 properties
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingUnit
string
Tracking unit
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentConditionUnit
string
Unit for the attachment condition amount.
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrors
object
Error details
1 property
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartUnit
string
Unit for the start period if type is FIXEDPERIOD.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Deel 12
Other APIs Deel publishes across the network.
Deel Adjustments API
Deel Applications API
Deel Candidates API
Deel Contractor Amendments API
Deel Contractor Hiring API
Deel Contracts API
Deel Custom Fields API
Deel IT API
Deel EOR Amendments API
Deel EOR Benefits API
Deel EOR Cost Calculator API
Deel EOR Hiring API
#subpackage_timeOff
Where this information came from
This is an independent, third-party profile of Deel Subpackage Time Off API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.