time off balances list
GET {{baseUrl}}/time-off-balances
Returns a list of TimeOffBalance objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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 balances 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. | |
policy_type | string | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | |
remote_fields | string | Which fields should be returned in non-normalized form. | |
remote_id | string | The API provider's ID for the given object. |
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","balance":93846070.4296422,"used":-127335.86175857484,"policy_type":"SICK","remote_data":[{"path":"deserunt consequat culpa consectetur","data":{"sunt5e":{},"enim_4b6":{},"quiac":{}}},{"path":"aliqua tempor","data":{"ina":{},"ut_b7":{}}}],"remote_was_deleted":true},{"id":"91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id":"19202938","employee":"d2f972d0-2526-434b-9409-4c3b468e08f0","balance":50702890.06558591,"used":-15193361.43173486,"policy_type":"JURY_DUTY","remote_data":[{"path":"Duis aliquip elit","data":{"doeb":{},"tempor_a":{}}},{"path":"elit aute","data":{"culpa8":{},"cupidatat_97":{}}}],"remote_was_deleted":false}]}