Sign in

v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Shifts

List Shifts

get/v2/company/{company_id}/shifts

Path parameters

company_idinteger required

Company ID

Query parameters

cursorstring

Cursor for the next or previous page of results.

limitinteger

The number of results desired per page.

location_idinteger

Location ID

shift_idsinteger[]

A comma separated list of Shift IDs

department_idinteger

Department ID

department_idsinteger[]

Department IDs

role_idinteger

Role ID

user_idinteger

User ID

start[lte]string date-time

RFC 3339 date/time format

Example:2021-01-30T08:30:00Z

Return shifts that start before or on specified date. In ISO8601 Format

start[gte]string date-time

RFC 3339 date/time format

Example:2021-01-30T08:30:00Z

Return shifts that start after or on specified date time. In ISO8601 Format

end[lte]string date-time

RFC 3339 date/time format

Example:2021-01-30T08:30:00Z

Return shifts that end before or on specified date time. In ISO8601 Format

end[gte]string date-time

RFC 3339 date/time format

Example:2021-01-30T08:30:00Z

Return shifts that end after or on specified date time. In ISO8601 Format

deletedboolean

Return shifts that were published and have been deleted. Cannot be combined with draft.

include_deletedboolean

Return shifts that are deleted.

draftboolean

Return shifts that are in draft. Draft shifts have created, edited or deleted but not been published. Overrides deleted flag.

include_draftboolean

Return shifts that are published, and also shifts in draft. Overrides deleted flag and draft flag.

openboolean

Return shifts that are open. Open shifts means anyone can request to take it and not assigned to any individual.

modified_sincestring date-time

RFC 3339 date/time format

Example:2021-01-30T08:30:00Z

Return only shifts that have been modified from specified date time. In ISO8601 Format

sort_bystring

Sort by either start or end

sort_dirstring

Sort by direction (asc, desc)

consider_tz_in_rangesboolean

When passing start[lte], start[gte], end[lte], or end[gte] parameters, consider the offset passed. Previously we ignored the offset and treated all datetimes as local location time

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

Success

object'shifts' required