Get employees

Returns an array of Employee objects containing information about restaurant employees.

Securityoauth2
Request
query Parameters
employeeIds
string <string>

An optional identifier that filters return values for a specific employee. The identifier can be a Toast platform GUID or an external identifier. If present, the employees resource will only return the employees you specify. You can include multiple employeeIds query parameters (maximum 100). If not present, the resource returns each employee for the restaurant.

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

JSON objects for all employees in the restaurant

500

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

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