---
title: "Get Time Off Balances List"
method: GET
path: "/api/hris/v1/time-off-balances"
tags: ["Time Off Balance"]
---

# Get Time Off Balances List

`GET /api/hris/v1/time-off-balances`

Returns a list of TimeOffBalance objects.

## Query parameters

- `ids` string, nullable — The ID of the time off balances to fetch
- `remote_id` string — The third-party API ID of the matching object.
- `employee_id` string, nullable — The ID of the employees to fetch time off balance for
- `include_raw_data` boolean — Whether to include the original data Bindbee fetched from the third-party to produce these models.
- `include_custom_fields` boolean — Whether to include custom fields in the response.
- `page_size` integer — Number of results to return per page. Maximum size is 200.
- `cursor` string — The pagination cursor value.
- `modified_after` string — If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)
- `expand` string — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

## Headers

- `x-connector-token` string, required

## Response `200`

Successful Response

- PaginatedResponseHrisTimeOffBalance
  - `cursor` string, nullable, required — Cursor value to fetch next set of items
  - `page_size` integer, required — Indicates the count of items in the response
  - `items` HrisTimeOffBalance[], required — List of items in the current response
    - `id` string, uuid, required
    - `remote_id` string, nullable, required — The third-party API ID of the matching object.
    - `modified_at` string, required — This is the datetime that this object was last updated by Bindbee
    - `raw_data` object, nullable — This is the Raw data
    - `custom_fields` object, nullable, required — The custom fields related to the model
    - `employee` string, nullable, required — The employee the balance belongs to.
    - `balance` union, required — The current remaining PTO balance, always measured in terms of hours.
      - integer
      - number
    - `used` union, required — The amount of PTO used in terms of hours.
      - integer
      - number
    - `policy_type` 'VACATION' | 'SICK' | 'PERSONAL' | 'JURY_DUTY' | 'VOLUNTEER' | 'BEREAVEMENT' | 'MATERNITY' | 'ANNUAL_LEAVE' | 'EMERGENCY_LEAVE' | 'LEAVE_OF_ABSENCE' | 'PATERNITY' | 'PAID_TIME_OFF' | 'LONG_TERM_DISABILITY' | 'SHORT_TERM_DISABILITY' | 'COMP_OFF' | 'WORK_FROM_HOME' | 'COMPASSIONATE' | 'TIME_OFF' | 'FMLA', nullable, required — The policy type of this time off balance. If the value is not one of the defined enum values, the original value passed through will be returned.

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/bindbee/apis/bindbee-apis.md) · [All operations](https://skmtc.net/bindbee/apis/bindbee-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bindbee/bindbee-apis/revisions/7da10dc93a21/schema)