Get a shift

Returns a Shift object containing of information about one schedule shift for a restaurant employee.

Securityoauth2
Request
path Parameters
shiftId
required
string

The Toast platform GUID or an external identifier for the shift.

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.

400

The GUID or external identifier was malformed.

404

The GUID or external identifier does not match any shifts at the current restaurant.

500

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

get/shifts/{shiftId}
Request samples
curl -i -X GET \
  'https://toast-api-server/labor/v1/shifts/{shiftId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "jobReference": {
    },
  • "employeeReference": {
    },
  • "inDate": "2019-08-24T14:15:22Z",
  • "outDate": "2019-08-24T14:15:22Z",
  • "scheduleConfig": {
    }
}