COconnecteam
Schedule:v2:Schedulers:Schedule:Shifts (V2):Shifts

Get shifts

Changed on

Retrieve a list of shifts under a specific schedule

get/scheduler/v2/schedulers/{schedulerId}/shifts

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/scheduler/v2/schedulers/{schedulerId}/shifts
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: schedule.read

Path parameters

schedulerIdinteger required

The unique identifier of the schedule

Query parameters

startTimeinteger required

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

endTimeinteger required

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

isOpenShiftboolean nullable

Filter shifts that are open shifts

isPublishedboolean nullable

Filter shifts that are published

isRequireAdminApprovalboolean nullable

Filter shifts that require admin approval

jobIdstring[] nullable

List of job IDs

assignedUserIdsinteger[] nullable

List of user IDs

shiftIdstring[] nullable

List of shift IDs

titlestring nullable

Title of the shift

sort'created_at' | 'updated_at'

Sort key

order'asc' | 'desc'

Sort order, set only if sort key is set

limitinteger

The maximum number of results to display per page

offsetinteger

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

Response

Successful Response

requestIdstring

Changes