API Reference
Back to 7shifts.comBecome a Partner

List Shifts

get
https://api.7shifts.com/v2/company//shifts
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Company ID

Query Params
string

Cursor for the next or previous page of results.

int64
1 to 500
Defaults to 100

The number of results desired per page.

int64

Location ID

shift_ids
array of integers
length ≥ 1

A comma separated list of Shift IDs

shift_ids
int64

Department ID

department_ids
array of integers
length ≥ 1

Department IDs

department_ids
int64

Role ID

int64

User ID

date-time

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

date-time

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

date-time

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

date-time

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

boolean
Defaults to false

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

boolean
Defaults to false

Return shifts that are deleted.

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean

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

date-time

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

string

Sort by either start or end

string

Sort by direction (asc, desc)

Headers
string

7shifts API version

uuid

Company GUID

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 11 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 11 months ago