/time-off
/time-off
Returns a list of TimeOff objects.
Authentication
AuthorizationBearer
Token-based authentication with required prefix “Bearer”
Headers
X-Account-Token
Token identifying the end user.
Query parameters
approver_id
If provided, will only return time off for this approver.
created_after
If provided, will only return objects created after this datetime.
created_before
If provided, will only return objects created before this datetime.
cursor
The pagination cursor value.
employee_id
If provided, will only return time off for this employee.
ended_after
If provided, will only return employees that ended after this datetime.
ended_before
If provided, will only return time-offs that ended before this datetime.
expand
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_deleted_data
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_data
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_data
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_after
If provided, only objects synced by Merge after this date time will be returned.
modified_before
If provided, only objects synced by Merge before this date time will be returned.
page_size
Number of results to return per page. The maximum limit is 100.
remote_fields
Deprecated. Use show_enum_origins.
remote_id
The API provider's ID for the given object.
request_type
If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
* `VACATION` - VACATION
* `SICK` - SICK
* `PERSONAL` - PERSONAL
* `JURY_DUTY` - JURY_DUTY
* `VOLUNTEER` - VOLUNTEER
* `BEREAVEMENT` - BEREAVEMENT
show_enum_origins
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_after
If provided, will only return time-offs that started after this datetime.
started_before
If provided, will only return time-offs that started before this datetime.
status
If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')
* `REQUESTED` - REQUESTED
* `APPROVED` - APPROVED
* `DECLINED` - DECLINED
* `CANCELLED` - CANCELLED
* `DELETED` - DELETED
Allowed values:
Response
next
previous
results