Deel subpackage_timeOff API
The subpackage_timeOff API from Deel — 11 operation(s) for subpackage_timeoff.
Deel subpackage_timeOff API is one of 91 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.1.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_timeOff 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), TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOff (26 properties), TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItems (26 properties). Each schema is shown below with its type and property counts.
time-off_getTimeOffDailies_Response_200
object
1 property
TimeOffsGetParametersStatusSchemaItems
string
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItems
object
8 properties
7 required
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile
object
3 properties
TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaData
object
3 properties
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
TimeOffsGetResponsesContentApplicationJsonSchemaDataItems
object
25 properties
12 required
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRecipientProfile
object
The time off profile of the recipient of the time off request. Must be a worker profile.
2 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType
string
How part-time workers are treated regarding entitlement.
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
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingCadence
string
Tracking cadence
Time Off_listTimeOffRequestsForOrganization_Response_200
object
Time offs associated to the query
4 properties
3 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItems
object
56 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsPartTimeWorkerAdditionalAllowanceType
string
How additional allowances apply to part-time workers.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyValidationTemplateRemindersItems
object
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItemsType
string
Event type
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsType
string
Type of the policy allowance
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
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentConditionUnit
string
Unit for the attachment condition amount.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartUnit
string
Unit for the waiting period if requeststarttype is FIXEDPERIOD.
TimeOffsPostResponsesContentApplicationJsonSchemaErrors
object
Error details
1 property
RetrievePolicyValidationTemplatesRequestBadRequestError
object
2 properties
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
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartUnit
string
Unit used for request start configuration
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItems
object
The dates breakdown for the time off request.
4 properties
1 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProration
object
Proration rules applied to the policy allowances.
11 properties
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsAttachmentsItems
object
An attachment associated with the time off request.
4 properties
4 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartType
string
When a worker can start requesting time off after becoming eligible.
time-off_validateTimeOff_Response_200
object
Time off request validation result
1 property
1 required
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems
object
Date with holiday or work status by day
2 properties
2 required
TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItems
object
The dates breakdown for the time off request.
4 properties
1 required
ExternalHrTimeOffSynchronizationRequestBadRequestError
object
2 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsNoticePeriodUnit
string
Unit for notice period
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaData
object
2 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingUnit
string
Unit used for tracking policy periods
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirthType
string
The type of the field, indicating it is a boolean field
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildren
object
Indicates if the request is for multiple children. Required for parental leave requests.
2 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementExpirationUnit
string
Unit for entitlement expiration period.
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDate
object
The birth-date of the child. Required for parental leave requests.
2 properties
2 required
TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyPolicyType
object
2 properties
2 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualApplicationType
string
Type of accrual application. Enum to indicate when accruals will be applied within the accrual cycles.
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementExpirationUnit
string
Unit used for entitlement expiration
TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataEventDetails
object
Event details regarding the leave. Required for event based policies such as parental leave.
4 properties
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType
object
3 properties
2 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDateType
string
The type of the field, indicating it is a date-only field
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaRequest
object
7 properties
TimeOffsReviewPostResponsesContentApplicationJsonSchemaRequest
object
7 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsIsAttachmentRequired
string
Whether an attachment is required for time off requests
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsBalanceTrackingType
string
Type of balance tracking. Determines how workers can request their time off.
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffType
object
The type of time off taken.
3 properties
2 required
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicy
object
The policy associated with the time off type.
3 properties
3 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartUnit
string
Unit used for entitlement start
TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItemsEventDetails
object
Details of the time off event
6 properties
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffAttachmentsItems
object
An attachment associated with the time off request.
4 properties
4 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualUnit
string
Unit used for accrual
TimeOffsProfileHrisProfileIdEntitlementsGetParametersPolicyTypeName
string
Policy type name
TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItemsStatus
string
Decision on whether the time off request was approved or rejected
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingUnit
string
Tracking unit
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile
object
3 properties
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrors
object
Error details
1 property
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…
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProration
object
Proration configuration for policy allowances
4 properties
4 required
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsType
string
Type of the holiday
CreateTimeOffRequest-v2026-01-01RequestBadRequestError
object
2 properties
ValidateTimeOffRequest-v2026-01-01RequestBadRequestError
object
2 properties
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItems
object
22 properties
5 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRetrospectiveRequestType
string
Rule for requesting time off for past dates.
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffRequestType
string
Type of time off requests allowed
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTimeOffTypesItems
object
2 properties
2 required
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType
string
Time off daily type
TimeOffsValidatePostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit
string
The unit in which the time off usage and entitlement are calculated.
TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType
string
The type of day for the time off request. All dates must follow the same type.
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicyPolicyType
object
2 properties
2 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsType
string
The type of day for the time off request. All dates must follow the same type.
TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDate
An specific date in the time-off request
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationHireProrationRule
string
Rule for prorating entitlement upon hiring.
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItems
object
14 properties
8 required
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsTimeOffDailyType
string
Type of work status or holiday
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingCadence
string
Determines when the tracking cycle starts.
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems
object
8 properties
7 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyType
object
Type of this policy
2 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualType
string
How entitlement accrues (over time or based on events).
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualApplicationType
string
When the accrued amount is applied to the balance.
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItems
object
Result of a specific country validation rule
4 properties
1 required
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDate
An specific date in the time-off request
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItems
object
Created time off request
26 properties
10 required
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems
object
24 properties
12 required
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…
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirth
object
Indicates if the child was born prematurely. Required for parental leave requests.
2 properties
2 required
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.
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEvent
object
8 properties
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0PolicyType
string
The Deel policy type of the policy the time off is being requested for.
TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataNotReviewedItems
object
2 properties
2 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRetrospectiveRequestType
string
Type of retrospective requests allowed
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
UpdateTimeOffRequestRequestBadRequestError
object
2 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsNoticePeriodUnit
string
Unit for the required notice period.
time-off_getTimeOffEvents_Response_200
object
List of time off events for the profile
1 property
1 required
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
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
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsBenefitsPayerType
string
Who pays for the benefits associated with this time off.
ApiErrorContainer
object
2 properties
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsAccrualUnit
string
Accrual unit
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
Status of time off
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems
object
8 properties
7 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsOverlapRequestType
string
Type of overlapping requests allowed
TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItemsStatus
string
Time off status after review
TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItems
object
2 properties
2 required
TimeOffsProfileHrisProfileIdPoliciesGetParametersPolicyTypeName
string
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffType
object
The type of time off taken.
3 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsBalanceTrackingType
string
How the balance is tracked (e.g., flexible, inflexible).
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffStatus
string
Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED.
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItems
object
3 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentCondition
string
Comparison operator if attachment is conditionally 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.
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartType
string
Type of entitlement start
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyType
object
Details of the associated policy type.
3 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartUnit
string
Unit for the start period if type is FIXEDPERIOD.
time-off_getTimeOffProfile_Response_200
object
Time offs associated to the query
4 properties
3 required
ApiErrorRequest
object
7 properties
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
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItems
object
Result of a specific country validation rule
4 properties
1 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsAutoApprovalInactivityTimeUnit
string
Unit for auto-approval inactivity time
TimeOffsValidatePostResponsesContentApplicationJsonSchemaRequest
object
7 properties
time-off_syncTimeOffGlobalPayroll_Response_200
object
List of time offs persisted at Deel
1 property
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsUploadAttachmentCondition
string
Condition under which an attachment is needed for a request.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingUnit
string
The unit used for tracking the policy cycle (e.g., yearly).
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsDataRangesItems
object
2 properties
1 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAdoptionDateDefinition
string
Rule regarding the requirement of an adoption date for relevant policies.
TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItems
object
2 properties
2 required
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType
string
The type of day for the time off request. All dates must follow the same type.
TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItems
object
The dates breakdown for the time off request.
4 properties
1 required
ApproveRejectTimeOffRequests-v2026-01-01RequestBadRequestError
object
2 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffTypesItems
object
3 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsTerminationType
string
Rule for handling the balance upon termination.
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
Status of time off
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItems
object
3 properties
3 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPaymentType
string
Payment type for the time off policy
TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaRequest
object
7 properties
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItemsType
string
Event type
ListPoliciesRequestNotFoundError
object
1 property
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAutoApprovalInactivityTimeUnit
string
Unit for the auto-approval inactivity period.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaRequest
object
7 properties
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicyPolicyType
object
2 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItems
object
26 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffTypeValidationsItems
object
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffRequestType
string
Allowed types of time off requests (e.g., full day, hourly).
time-off_deleteTimeOffRequest_Response_204
object
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems1
object
3 properties
3 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItems
object
Time off policy
29 properties
24 required
CreateTimeOffRequest-v2026-01-01RequestForbiddenError
object
2 properties
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicy
object
3 properties
3 required
ApiError
object
2 properties
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsEntitlementUnit
string
The unit in which the time off usage and entitlement are calculated.
TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType
string
Time off daily type
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventType
string
The type of the time off event.
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItemsType
string
Type of the time off daily. Can be WORKINGDAY, NONWORKINGDAY or HOLIDAY.
time-off_getTimeOffEntitlements_Response_200
object
2 properties
2 required
time-off_getTimeOffPolicyValidationTemplates_Response_200
object
1 property
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItems
object
8 properties
7 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsData
object
3 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationTerminationProrationRule
string
Rule for prorating entitlement upon termination.
TimeOffsPostRequestBodyContentApplicationJsonSchemaData
object
The time off request data
16 properties
3 required
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems0
object
12 properties
5 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaData
object
Time off request validation result
16 properties
1 required
TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItems
object
Time off event object
8 properties
8 required
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventType
string
The type of the time off event.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyTypesItems
object
3 properties
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…
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementUnit
string
Unit in which the entitlement is measured.
time-off_getTimeOffPolicies_Response_200
object
1 property
TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaData
object
Time off update request data
15 properties
3 required
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit
string
The unit in which the time off usage and entitlement are calculated.
CreateTimeOffRequest-v2026-01-01RequestNotFoundError
object
2 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverExpirationUnit
string
Unit used for rollover expiration
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItemsAmount
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRecipientProfile
object
The time off profile of the recipient of the time off request. Must be a worker profile.
2 properties
2 required
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicy
object
The policy associated with the time off type.
3 properties
3 required
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementUnit
string
Unit used for entitlement
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicyPolicyType
object
2 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualUnit
string
Unit for accrual if type is TIMEFRAME.
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEvent
object
8 properties
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItems
object
13 properties
8 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsDataRangesItems
object
2 properties
1 required
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsSource
string
Source of creation of the holiday
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaData
object
1 property
1 required
TimeOffsPostResponsesContentApplicationJsonSchemaRequest
object
Request metadata
6 properties
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsDayTypesItems
string
The type of leave for the day.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsOverlapRequestType
string
Rule for requesting time off that overlaps with existing requests.
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItems
object
7 properties
2 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsLeaveType
string
Classification of the leave duration.
TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile
object
3 properties
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.
TimeOffsReviewPostResponsesContentApplicationJsonSchemaData
object
2 properties
2 required
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffEntitlementUnit
string
The unit in which the time off usage and entitlement are calculated.
TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems
TimeOffsProfileHrisProfileIdGetParametersStatusSchemaItems
string
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
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverType
string
Rule for carrying over unused balance to the next cycle.
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicy
object
13 properties
4 required
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsType
string
Type of allowance (base or additional).
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualProrateTypesItems
string
TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType
string
The type of day for the time off request. All dates must follow the same type.
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAdditionalAllowanceRulesItems
object
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartType
string
Type of request start configuration
TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsStatus
string
Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED.
GetWorkScheduleAndHolidaysRequestBadRequestError
object
2 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType
string
Type of treatment for part-time workers
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItems
object
14 properties
8 required
time-off_updateTimeOffRequest_Response_200
object
Time off data to be updated
1 property
1 required
TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile
object
3 properties
TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaData
object
Time off request data
13 properties
3 required
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItemsType
string
Type of the time off daily. Can be WORKINGDAY, NONWORKINGDAY or HOLIDAY.
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItems
object
23 properties
22 required
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDate
object
The adoption-date of the child. Might be required depending on the type if leave requests.
2 properties
2 required
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
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverExpirationUnit
string
Unit for the expiration period of rolled-over balance.
GetTimeOffEventsForProfileRequestBadRequestError
object
2 properties
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDateType
string
The type of the field, indicating it is a date-only field
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverType
string
Type of rollover
TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyLeaveType
string
Leave type
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingCadence
string
Cadence for tracking policy periods
TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaRequest
object
7 properties
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkSchedule
object
Detail of working hours by week day for an HRIS profile
3 properties
TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartType
string
When the entitlement starts.
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFields
object
Fields required for specific time off requests, such as parental leave.
4 properties
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildrenType
string
The type of the field, indicating it is a boolean field
TimeOffsReviewPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsLeaveType
string
Type of leave for this policy
TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualType
string
Type of accrual for the allowance. Determines how/when profiles should earn their entitlement (aka: allowance).
TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsData
object
3 properties
TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkScheduleWorkWeek
object
The work week schedule for the HRIS profile
7 properties
7 required
TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaRequest
object
Request metadata
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Deel 12
Other APIs Deel publishes across the network.
Deel Default API
Deel subpackage_accounting API
Deel subpackage_adjustments API
Deel subpackage_assets API
Deel subpackage_ats API
Deel subpackage_candidates API
Deel subpackage_consent API
Deel subpackage_contractorAmendments API
Deel subpackage_contractorHiring API
Deel subpackage_contracts API
Deel subpackage_costCalculator API
Deel subpackage_costCenters API
#subpackage_timeOff
Where this information came from
This is an independent, third-party profile of Deel subpackage_timeOff 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.