Unarchive an employee

Unarchives an employee record that was previously archived.

  • Unarchived employees can sign into the Toast POS.
  • Unarchived employees can sign in to Toast Web.
  • When you unarchive an employee, the employee has all jobs that were previously assigned to them.
  • If an employee had a swipe card for signing into the Toast POS, the swipe card is not re-associated with the employee when you unarchive them.

If you unarchive an employee who will take a different role than the one they had when they were archived, you must update the employee's jobs list and verify that the employee should continue to sign into Toast Web.

Securityoauth2
Request
path Parameters
employeeId
required
string

The Toast platform GUID of the employee record.

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.

Responses
200

Returns the updated employee record.

400

Employee being unarchived is not currently archived.

put/employees/{employeeId}/unarchive
Request samples
curl -i -X PUT \
  'https://toast-api-server/labor/v1/employees/{employeeId}/unarchive' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: string' \
  -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"
}