<- Labor API

Labor API

All versions ->

Search shifts

DEPRECATED

 /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
  • Team member IDs
  • Shift status (OPEN or CLOSED)
  • Shift start
  • Shift end
  • Workday details

The list can be sorted by:

  • START_AT
  • END_AT
  • CREATED_AT
  • UPDATED_AT
Permissions:TIMECARDS_READ

Deprecation date

2025-05-21

Retirement date

2026-05-21

Replaced by

SearchTimecards

Migration guide
Link to section

Request body

Example code

Link to section

query

Query filters.

Link to section

limit

integer(32-bit)

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

Link to section

cursor

string

An opaque cursor for fetching the next page.

Link to section

Response fields

Link to section

shifts

Shifts.

Link to section

cursor

string

An opaque cursor for fetching the next page.

Link to section

errors

Any errors that occurred during the request.