<- Labor API

Labor API

All versions ->

Search scheduled shiftsBeta

POST

 /v2/labor/scheduled-shifts/search

Returns a paginated list of scheduled shifts, with optional filter and sort settings.

By default, results are sorted by start_at in ascending order.

Permissions:TIMECARDS_READ

Guide

Scheduling with the Labor API

Try in API Explorer
Link to section

Request body

Example code

Link to section

query

Query conditions used to filter and sort the results.

Link to section

limit

integer(32-bit)

The maximum number of results to return in a single response page. The default value is 50.

Min
1
Max
50
Link to section

cursor

string

The pagination cursor returned by the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.

Link to section

Response fields

Link to section

scheduled_shifts

A paginated list of scheduled shifts that match the query conditions.

Link to section

cursor

string

The pagination cursor used to retrieve the next page of results. This field is present only if additional results are available.

Link to section

errors

Any errors that occurred during the request.