Get shifts

Returns an array of Shift objects that contain information about schedule shifts for restaurant employees.

Securityoauth2
Request
query Parameters
endDate
string <ISO-8601>

Optional end date and time of time period to match shifts. A shift matches the time period if the shift inDate is after (inclusive) the specified startDate and the shift outDate is before the endDate (exclusive). These parameters are required if the shiftIds parameter is not defined. The specified period cannot be longer than one month.

shiftIds
string <string>

An optional identifier that filters return values for a specific shift. The identifier can be a Toast platform GUID or an external identifier. If present, the shifts resource will only return the shifts you specify. You can include multiple shiftIds query parameters (maximum 100).

startDate
string <ISO-8601>

Optional start date and time of time period to match shifts. A shift matches the time period if the shift inDate is after (inclusive) the specified startDate and the shift outDate is before the endDate (exclusive). These parameters are required if the shiftIds parameter is not defined. The specified period cannot be longer than one month.

header Parameters
Toast-Restaurant-External-ID
required
string <string>

The Toast platform GUID of the restaurant that is the context for this operation.

Responses
200

Returns the specified shifts in an unordered list.

500

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

get/shifts
Request samples
curl -i -X GET \
  'https://toast-api-server/labor/v1/shifts?endDate=string&shiftIds=string&startDate=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
[
  • {
    }
]