Delete an employee

Deletes a restaurant employee record by marking the record as deleted. A deleted employee cannot log in at the restaurant or open new time entries.

If you GET an employee record that has been deleted, its deleted value is true and its deletedDate value contains the date and time the record was deleted. If you GET all employees for a restaurant, the GUIDs for deleted employees are not included in the return data.

If you delete an employee that has already been deleted then the result is successful (200) and no change is made.

The deleted record appears in the list of deleted employees for the restaurant in Toast Web. From the list of deleted employees, you can enable a deleted record so that the employee can use it again. You cannot enable a deleted employee using the labor API. Information about deleted employees remains available in reports.

You cannot delete employees who have open time entries (time entries that do not have an out date value).

Securityoauth2
Request
path Parameters
employeeId
required
string

The Toast platform GUID or external identifier for the employee to be deleted.

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

The employee has been deleted. Returns an Employee object containing information about the deleted restaurant employee.

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.

delete/employees/{employeeId}
Request samples
curl -i -X DELETE \
  'https://toast-api-server/labor/v1/employees/{employeeId}' \
  -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",
  • "firstName": "string",
  • "chosenName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "phoneNumberCountryCode": "string",
  • "passcode": "string",
  • "externalEmployeeId": "string",
  • "deleted": true,
  • "jobReferences": [
    ],
  • "wageOverrides": [
    ],
  • "v2EmployeeGuid": "string"
}