---
title: "List time off policies"
method: GET
path: "/api/business/{businessId}/time-off-policy"
tags: ["Time Off Policy"]
---

# List time off policies

`GET /api/business/{businessId}/time-off-policy`

## Request

- Base URL: `http://api-gateway-eu.phorest.com/third-party-api-server`
- URL: `http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/time-off-policy`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/time-off-policy/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a paginated list of the business's time off policies, ordered alphabetically by name. Time off policies are the types of time off (e.g. Holidays, Sick Leave, Parental Leave) that staff time off is rostered against. Rostered time off references a policy through timeOffPolicyId on staff work time table slots. Set fetch_archived=true when resolving policies for historical time off, as it may reference policies that have since been archived.

## Path parameters

- `businessId` string, required

## Query parameters

- `fetch_archived` boolean

## Response `200`

Time off policies listed

- DataPagedModelTimeOffPolicy
  - `_embedded` object
    - `timeOffPolicies` TimeOffPolicy[]
      - `timeOffPolicyId` string: Time off policy ID
      - `name` string: Name of the time off policy as shown in Phorest
      - `description` string: Optional description of the time off policy
      - `policyType` 'PAID_LEAVE' | 'SICK_LEAVE' | 'UNPAID_LEAVE': Category of the time off policy
      - `paid` boolean: Whether time off under this policy is paid. PAID_LEAVE and SICK_LEAVE are paid, UNPAID_LEAVE is not
      - `archived` boolean: Whether the time off policy has been archived. Archived policies can still be referenced by previously rostered time off
  - `page` PageMetadata
    - `size` integer
    - `totalElements` integer
    - `totalPages` integer
    - `number` integer

## Other responses

- `400`: Bad Request
- `404`: Business with the specified id doesn't exist
- `429`: Request rate limit exceeded. Current limit set to 100 rps.
- `500`: Internal Server Error

## Changes

- **2026-11-03** `beea6ef29634`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/phorest/apis/third-party-api/changes/api/business/:businessId/time-off-policy/get.md)

---

[API](https://skmtc.dev/phorest/apis/third-party-api.md) - [All operations](https://skmtc.dev/phorest/apis/third-party-api/llms.txt) - [OpenAPI document](https://skmtc.dev/phorest/apis/third-party-api/revisions/beea6ef29634?raw)