Get jobs

Returns an array of Job objects containing information about the employee jobs configured at a restaurant.

Securityoauth2
Request
query Parameters
jobIds
Array of strings

An optional array of one or more job identifiers, either the Toast platform GUID or an external identifier assigned by the client. 100 max. If not provided, all jobs known to the Toast platform for this restaurant will be returned.

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 jobs.

500

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

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