time off list
GET {{baseUrl}}/time-off
Returns a list of TimeOff objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
approver_id | string | If provided, will only return time off for this approver. | |
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
employee_id | string | If provided, will only return time off for this employee. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was marked as deleted by third party webhooks. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_fields | string | Which fields should be returned in non-normalized form. | |
remote_id | string | The API provider's ID for the given object. | |
request_type | string | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | |
status | string | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id":"19202938","employee":"d2f972d0-2526-434b-9409-4c3b468e08f0","approver":"9efbc633-3387-4306-aa55-e2c635e6bb4f","status":"APPROVED","employee_note":"Moving into the new apartment Kendall Roy gave me!","units":"HOURS","amount":3,"request_type":"JURY_DUTY","start_time":"2020-11-10T00:00:00Z","end_time":"2020-11-17T00:00:00Z","remote_data":[{"path":"et","data":{"id09":{},"id_738":{}}},{"path":"irure","data":{"Excepteur9_8":{},"dolore_4c":{},"pariatur_ace":{}}}],"remote_was_deleted":true},{"id":"91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id":"19202938","employee":"d2f972d0-2526-434b-9409-4c3b468e08f0","approver":"9efbc633-3387-4306-aa55-e2c635e6bb4f","status":"CANCELLED","employee_note":"Moving into the new apartment Kendall Roy gave me!","units":"HOURS","amount":3,"request_type":"SICK","start_time":"2020-11-10T00:00:00Z","end_time":"2020-11-17T00:00:00Z","remote_data":[{"path":"ullamco cupidatat","data":{"exercitation1":{},"labore6":{}}},{"path":"ex tempor enim","data":{"nullacc":{},"dolor96":{}}}],"remote_was_deleted":true}]}