7S7shifts
Time Off

List Time Off

get/v2/time_off

Request

  • Base URL
    https://api.7shifts.com
  • Auth
    • OAuth 2
      Authorization codehttps://app.7shifts.com/oauth2/authorize
      Client credentials
      Password
      Token URLhttps://app.7shifts.com/oauth2/token
    • or API key in cookie 7session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

company_idinteger required

Company ID

location_idinteger

Location ID

user_idinteger

User ID

statusinteger

Status

category'paid' | 'unpaid' | 'paid_sick'

Category

to_date_gtestring

A date with YYYY-MM-DD format

Example:2020-01-01

Return time offs that end after a specified date.

sort_by'created' | 'from_date'

Sort by column

sort_dir'asc' | 'desc'

Sort by direction (asc, desc)

cursorstring

Cursor for the next or previous page of results.

limitinteger

The number of results desired per page.

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

An array of time off requests

Changes

No recorded changes to this operation across all 2 revisions of this API.