---
title: "List Time Off"
method: GET
path: "/v2/time_off"
tags: ["Time Off"]
---

# List Time Off

`GET /v2/time_off`

## Query parameters

- `company_id` integer, required
- `location_id` integer
- `user_id` integer
- `status` integer
- `category` 'paid' | 'unpaid' | 'paid_sick'
- `to_date_gte` string — A date with YYYY-MM-DD format
- `sort_by` 'created' | 'from_date'
- `sort_dir` 'asc' | 'desc'
- `cursor` string
- `limit` integer

## Headers

- `x-api-version` string — An API version
- `x-company-guid` string, uuid

## Response `200`

An array of time off requests

- object
  - `data` object[], required
    - `id` integer, required
    - `user_id` integer, required
    - `company_id` integer, required
    - `from_date` string, required
    - `to_date` string, required
    - `partial` boolean, required
    - `partial_from` string, time, nullable, required
    - `partial_to` string, time, nullable, required
    - `comments` string, required
    - `status` integer, required
    - `status_action_user_id` integer, nullable, required
    - `status_action_message` string, required
    - `category` string, required
    - `created` string, required
    - `amount_of_hours` number, required
    - `hours` object[], required
      - `date` string, required
      - `hours` number, required
  - `meta` object, required
    - `cursor` object, required
      - `current` string, nullable, required — The current cursor.
      - `prev` string, nullable, required — A cursor for navigating to the previous page.
      - `next` string, nullable, required — A cursor for navigating to the next page.
      - `count` integer, nullable, required — The total items in the current cursor.

---

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