---
title: "Worker Time Off"
method: GET
path: "/workers/{workerId}/timeoff"
tags: ["Worker"]
---

# Worker Time Off

`GET /workers/{workerId}/timeoff`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/workers/{workerId}/timeoff`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/workers/:workerId/timeoff/get.ts> (a function with typed inputs; its response is checked against the schema)

Array of time off balance(s) a worker has for each policy type of time off, for that worker. NOTE: This data is only available if the client has the Time Off Accrual product (This is not related to the Flex Time product which has it is own dev portal for those APIs).

## Path parameters

- `workerId` string, required

## Response `200`

successful operation

- object
  - `metadata` MetadataResource
    - `contentItemCount` integer
    - `pagination` PaginationMetadataResource
      - `offset` integer
      - `limit` integer
      - `itemCount` integer
      - `total` integer
  - `content` TimeOffResource: The representational state of a workers time off.
    - `policyId` string: The unique ID assigned to the company policy.
    - `type` string: The policy type the client has assigned at the company level
    - `name` string: The name of the policy the client has assigned at the company level.
    - `balance` string: The current balance for this worker, for the associated policy type.
    - `measure` 'HOURS' | 'UNITS': Type of measurement type to be applied to the balance.
  - `links` Link1[]
    - `href` string
    - `hreflang` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string
    - `templated` boolean

## Other responses

- `400`: The value for the one of the field is invalid
- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)
- `404`: Invalid resource ID (API-7)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `500`: Internal Server Error.
- `503`: service unavailable (API-66)

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)