Get Completed Shifts
Learn how to get all closed shifts for the workweek and get additional results.
You need a valid access token. You should test with Sandbox credentials whenever possible. For more information, see Access Tokens and Other Square Credentials.
If you're using OAuth, you need
TIMECARDS_WRITE
permission to update aShift
andTIMECARDS_READ
permission to retrieve aShift
.You need to create a
Shift
object using the Labor API. To create your first shift, see Build with the Labor API.You need to know the shift ID you want to update.
Requests to the SearchShifts
endpoint include search filters and sorting instructions. The following request asks for all complete shifts during a 1-week pay period for the given location with the following characteristics:
The targeted pay period is May 12, 2023, through May 19, 2023.
The result is sorted using the shift creation timestamp in ascending order.
The results are limited to 20 shifts per response (page size).
Did you know?
The default time zone is set in the filter and used in the query when a time zone isn't set in the Seller Dashboard for the targeted location.
Calls to the SearchShifts
endpoint must use a POST command:
If you need more assistance, contact Developer Support or ask for help in the Developer Forums.