Get information about one employee

Returns an Employee object containing information about one restaurant employee.

Request
path Parameters
employeeId
required
string

The Toast platform GUID or external identifier for the employee to 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 employee information.

400

The GUID or external identifier was malformed.

404

The GUID or external identifier does not match any employees 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/employees/{employeeId}
Request samples
curl -i -X GET \
  'https://toast-api-server/labor/v1/employees/{employeeId}' \
  -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",
  • "firstName": "string",
  • "chosenName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "passcode": "string",
  • "externalEmployeeId": "string",
  • "deleted": true,
  • "disabled": true,
  • "jobReferences": [
    ],
  • "wageOverrides": [
    ],
  • "v2EmployeeGuid": "string"
}