---
title: "Retrieve Time Off Settings"
method: GET
path: "/v2/time_off_settings/{company_id}"
tags: ["Time Off"]
---

# Retrieve Time Off Settings

`GET /v2/time_off_settings/{company_id}`

## Request

- Base URL: `https://api.7shifts.com`
- URL: `https://api.7shifts.com/v2/time_off_settings/{company_id}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://app.7shifts.com/oauth2/authorize`
    - Client credentials
    - Password
    - Token URL: `https://app.7shifts.com/oauth2/token`
  - API key in cookie `7session`
- TypeScript: <https://skmtc.dev/7shifts/apis/7shifts-api/docs/v2/time_off_settings/:company_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `company_id` integer, required

## Headers

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

## Response `200`

TimeOff settings for company

- object
  - `company_id` integer, required
  - `time_off_request_comment` boolean, required
  - `time_off_request_notice` number, required
  - `categories` object[], required
    - `label` string
    - `value` string
    - `require_hours` boolean
    - `active` boolean

## Other responses

- `403`: No permission to access time off settings for company

---

[API](https://skmtc.dev/7shifts/apis/7shifts-api.md) - [All operations](https://skmtc.dev/7shifts/apis/7shifts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/7shifts/apis/7shifts-api/revisions/40e0ef40dfcd?raw)