/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
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+2ba2/iOBSG/0rkT7sVl7ZMt1uk1YqScmmHlIF0drqjUXRwDsGQxKnjlMJo/vsqFyi9jdSOaaGbbyTYb8zjN8fHF74TChIdLmakSkaChaRAPG6jS6rEZB6eD4ekQCBgBniYFbGu90mBhFEQcCHRbjB07bAlcEiqpOyhcLAY+WzI0C7HxcvMl+gIkIz7YXlZrThM6pECcZk/QbtGKY98+TOhtGAR0pL3LuOvQ0kKJIAwlCPBI2fUw6sIw59qxu1x0UNfglu0QUJ5pX5RpAKP3YtbbqOLEm0dJOgokcY/MXvWSMogrJbLI3SDUvLcko3XZfTLICSjLoblg8rR/uHRQTFTSZ7+t+W4f+3tjK8GfHC4YznUtSDa6Zj0xjDbU2PsfDDqH26M+cWBMZ/MjfFkd8dyYKdjdg7OzcvKuV7bO3+kgNX/48vR52P9+NTYofOTijG+nBom3euYdDKYtyunTTo9bX26MeaX+x39omKYJwenTb53Xu+FnXqPd2qlEimQ1Z4k1a/fV29kBqnpXU0/qbf19kXnbo22Bw6ukEk7AwJWDKKBy2gprJTAgzn3YRqWKPfKHtoMyjW9a+lImc0iz+pfRSCwFPjOAj/j/pI9qZITo1Uz6if6XSPUroG5MHCRVKWI8IF7SfUrgSAQ/BoFKRD0ApfPEFc+Wj6XybVvW5J58UeBHpdoxd1298oKQI5ubzE7fl0kCLmoGUqQUWygyGcyJN/iolcRE2h3QYCHEkXcpG8/Ck8hNvBGak301SGOFa0m+mtF7MVv6noAZ6+lJWcBquf9DxeTIRcUNYNP1UFfyloGn+bk75M/Bm/AeaunBvhCLeNsfeQOL42DHHYGWyDIESpinYqtorYal0f/OmNvvcjXG8XXR78+AuEyRfQzsXtWX2tc2VbuOsySAKwGfNcFOeTCW6i+21h+FcUV0JdxKi1eDB/RVQwe0X230J8PuAFUcsFAEeWl3OvFle3Czd1JqKnKVxaeTlSt8P0lhy9kHInkKSr8nGi9R7S/6GOB4UgieIowL+ReZYazrZlIE30UjGr9htlVw91JFa1wKIPM5JZ3WrnZbV9sZhe8QQrSAubiTHnMTmWtVu/1osqzDL0uE7fYgA8Uo4wlNxTja8SFVk/rgpB+4nEFXFu9TC5fB3mCd7wqFyo2cSqa5xi3mCMPwFeEORN7PUdva5LRijymBvko8lgxz5zv8T2NQjlVFz6WcnmsfhT3GU5ADekJTiCfCD7k64+52pEwkdw80qo3aT9GlCqyZiL1JsPZxvnxfDhklGHSZgVkl3Kv7cdNwSmAuqjVXR7ZWpxD+VodAibB1Trgg5Oci9F+a9U7vysCnjxw897+N++IWShRqFqESNXeMeVn0u3CjHJFs+fFMBYkmu+Y8Qud3EUeuKhsOS1Ts2qUYhjmJ2Qe4hYh95mqHC1TW8w2GvwzNA/NnPctbxd8G2ZqY0kmuhbML0znFETdXqKqhlTawmy5wc0PszyBvA8OKtvKiMWslSNElcH0w2EnjwV3aacjlELiqeCCOr3pt+nZeOuo//o+f7/W1fpRMuynx04ULand1bxzQPGYfuFOYzdfX7vtBAzBU+TuxWiXav6PN/T6IwhQlZsTLUsXCJ4Zn7DItvmvoTGU9vEGxY11Q2VpCxRN85Zy2zrlUIjWFMxAqcX70NkrrIaxKZiP0trbOrbrc/HFWVPrCr7yd5PbdTg10C/OmosYYcPRp92DTYoRm4C/h2Armt+tsHYQWn9edfNpy2PYY7crn1Rnom/mbmWHsJ59zu3bj/8AeyyIxtY7AAA=" />