---
title: "Retrieve a list of Time Off"
method: GET
path: "/v2/timeoff"
tags: ["TimeOffs"]
---

# Retrieve a list of Time Off

`GET /v2/timeoff`

Retrieves a paginated list of Time Off based on the applied filters and pagination.

## Query parameters

- `pageSize` number
- `page` number
- `field` 'id' | 'techId' | 'startDate' | 'endDate' | 'status' | 'reason' | 'details' | 'isAllDay' | 'updatedAt' | 'createdAt'
- `order` 'ASC' | 'DESC'
- `techId` string[]
- `baseDate` string, date-time
- `timeline` 'prev' | 'next'

## Headers

- `Authorization` string, required

## Response `200`

A paginated list of Time Off.

- ResponseTimeoffsV2Dto
  - `pageSize` number — The maximum number of items returned per page.
  - `page` number — The current page number.
  - `totalResults` number — The total number of results.
  - `hasMore` boolean — Whether there are more results.
  - `data` ResponseTimeOffV2Dto[] — A list of Time Off.
    - `id` string — The ID of the time off.
    - `techId` string — The assigned tech ID (prefix `USR-`). Use `-1` to assign to all company techs.
    - `startDate` string, date-time — The time & date when the time off starts.
    - `endDate` string, date-time — The time & date when the time off ends.
    - `status` 'approved' | 'pending' | 'declined' — The status of the time off.
    - `reason` 'Vacation' | 'Sick day' | 'Personal' | 'Company Added' | 'Other' — The reason for the time off.
    - `details` string — Details about the time off.
    - `isAllDay` boolean — Whether the time off is for the entire day.
    - `updatedAt` string, date-time — The date and time the time off was updated.
    - `createdAt` string, date-time — The date and time the time off was created.

## Other responses

- `400` — Invalid sort field, order direction, tech ID, or incomplete/invalid baseDate and timeline filters.
- `401` — Missing or invalid authentication token.

---

[API](https://skmtc.net/workiz/apis/developer-api.md) · [All operations](https://skmtc.net/workiz/apis/developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/workiz/developer-api/revisions/14666f4db0f8/schema)