For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Token-based authentication with required prefix “Bearer”
Headers
X-Account-TokenstringRequired
Token identifying the end user.
Query parameters
approver_idstringOptional
If provided, will only return time off for this approver.
created_afterdatetimeOptional
If provided, will only return objects created after this datetime.
created_beforedatetimeOptional
If provided, will only return objects created before this datetime.
cursorstringOptional
The pagination cursor value.
employee_idstringOptional
If provided, will only return time off for this employee.
ended_afterdatetimeOptional
If provided, will only return employees that ended after this datetime.
ended_beforedatetimeOptional
If provided, will only return time-offs that ended before this datetime.
expandlist of enumsOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_deleted_databooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
include_remote_databooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_databooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterdatetimeOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforedatetimeOptional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.
remote_fieldsenumOptional
Deprecated. Use show_enum_origins.
remote_idstringOptional
The API provider's ID for the given object.
request_typeenumOptional
If provided, will only return TimeOff with this request type. Options: (‘VACATION’, ‘SICK’, ‘PERSONAL’, ‘JURY_DUTY’, ‘VOLUNTEER’, ‘BEREAVEMENT’, ‘LEAVE’)
show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
started_afterdatetimeOptional
If provided, will only return time-offs that started after this datetime.
started_beforedatetimeOptional
If provided, will only return time-offs that started before this datetime.
statusenumOptional
If provided, will only return TimeOff with this status. Options: (‘REQUESTED’, ‘APPROVED’, ‘DECLINED’, ‘CANCELLED’, ‘DELETED’)
Allowed values:
Response
nextstring or nullOptional
previousstring or nullOptional
resultslist of objectsOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. Learn more
