<- Labor API

Labor API

Search shifts

POST

 /v2/labor/shifts/search

Returns a paginated list of Shift records for a business.

The list to be returned can be filtered by:

  • Location IDs.
  • Employee IDs.
  • Shift status (OPEN and CLOSED).
  • Shift start.
  • Shift end.
  • Workday details.

The list can be sorted by:

  • start_at.
  • end_at.
  • created_at.
  • updated_at.
Permissions:TIMECARDS_READ
Try in API Explorer
Link to section

Request body

Example code

Link to section

query

Query filters.

Show attributes
Link to section

limit

integer(32-bit)

The number of resources in a page (200 by default).

Min
1
Max
200
Link to section

cursor

string

An opaque cursor for fetching the next page.

Link to section

Response fields

Link to section

shifts

Shifts.

Show attributes
Link to section

cursor

string

An opaque cursor for fetching the next page.

Link to section

errors

Any errors that occurred during the request.

Show attributes