Add an employee

Creates a restaurant employee record.

Securityoauth2
Request
header Parameters
Content-Type
required
string <string>

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

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

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

Request Body schema: application/json

An Employee object containing information about the employee, including the employee's name and email address.

string
Responses
200

Returns the created employee.

400

The request contains data that is not supported by the current version of the API as described.

415

The request did not have "application/json" in the Content-Type header.

500

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

post/employees
Request samples
application/json
{
  • "entityType": "RestaurantUser",
  • "email": "email",
  • "firstName": "first name",
  • "chosenName": "optional chosen name",
  • "lastName": "last name",
  • "externalId": "optional external ID",
  • "externalEmployeeId": "optional external employee ID",
  • "jobReferences"": [
    ],
  • "wageOverrides": [
    ]
}
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",
  • "phoneNumberCountryCode": "string",
  • "passcode": "string",
  • "externalEmployeeId": "string",
  • "deleted": true,
  • "jobReferences": [
    ],
  • "wageOverrides": [
    ],
  • "v2EmployeeGuid": "string"
}