---
title: "GET /v1/time_off/balances"
method: GET
path: "/v1/time_off/balances"
tags: ["Time Off"]
---

# GET /v1/time_off/balances

`GET /v1/time_off/balances`

Get worker remaining time-off balances.

## Query parameters

- `limit` string — a number less than or equal to 100
- `afterId` string
- `beforeId` string
- `policyIds` string[]
- `workerIds` string[]
- `startDate` string — a string to be decoded into a Date
- `endDate` string — a string to be decoded into a Date

## Response `200`

Success

- object
  - `hasMore` boolean, required
  - `count` integer, required — an integer
  - `data` object[], required
    - `id` string, required
    - `policyId` string, required — a string starting with "top_"
    - `legacyWorkerId` string, required
    - `accruedUnlocked` number, required
    - `accruedLocked` number, required
    - `used` number, required
    - `holds` number, required
    - `available` number, required

## Other responses

- `400` — The request did not match the expected schema
- `401` — ApiKeyUnauthorized
- `403` — MissingRequiredPermissions
- `404` — TimeOffPolicyNotFound
- `429` — RateLimitExceeded
- `500` — InternalServerError

## Changes

- **2026-03-19** `a896c17cf988` — 4 breaking, 1 info
  - the response's body type/format changed from `object`/`` to ``/`` for status `403`
  - removed the required property `_tag` from the response with the `403` status
  - removed the required property `message` from the response with the `403` status
  - removed the required property `requiredPermissions` from the response with the `403` status
  - …1 more
- **2026-03-13** `6cfbdf910b80` — 1 warning
  - added the new `company:workplaces` enum value to the `requiredPermissions/items/scope` response property for the response status `403`
- **2026-03-09** `768d9cb8d8d9` — 2 breaking, 3 info
  - the `requiredPermissions/items/` response property's minItems was decreased from `2` to `0` for the response status `403`
  - the `requiredPermissions/items/` response's property type/format changed from `array`/`` to `object`/`` for status `403`
  - removed `subschema #1, subschema #2` from the `requiredPermissions/items/` response property 'prefixItems' list for the response status `403`
  - added the required property `requiredPermissions/items/level` to the response with the `403` status
  - …1 more
- **2026-03-09** `787281d7e9a2` — 1 info
  - added the non-success response with the status `403`
- **2026-01-16** `d256b456551d` — 1 info
  - added the required property `count` to the response with the `200` status

[Full history](https://skmtc.dev/teamwarp/apis/warp-api/changes/v1/time_off/balances/get.md)

---

[API](https://skmtc.dev/teamwarp/apis/warp-api.md) · [All operations](https://skmtc.dev/teamwarp/apis/warp-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/teamwarp/warp-api/revisions/f3df5d5ca575/schema)