API Reference

Get shifts

get
https://api.connecteam.com/scheduler/v2/schedulers//shifts

Retrieve a list of shifts under a specific schedule

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The unique identifier of the schedule

Query Params
integer
required

The start time to filter by in Unix format (in seconds)

integer
required

The end time to filter by in Unix format (in seconds)

Filter shifts that are open shifts

Filter shifts that are published

Filter shifts that require admin approval

array | null

List of job IDs

array | null

List of user IDs

array | null

List of shift IDs

Title of the shift

string
enum
Defaults to created_at

Sort key

Allowed:
string
enum
Defaults to asc

Sort order, set only if sort key is set

Allowed:
integer
1 to 500
Defaults to 10

The maximum number of results to display per page

integer
≥ 0
Defaults to 0

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?