This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Adding a shift and assigning it to an employee

Send a POST request to the /labor/v1/shifts resource of the labor API to add a shift and assign it to an employee of your restaurant. The resource returns a JSON object containing information about the employee, including the Toast POS GUID, when it creates the employee record.

The following example curl command sends a POST request to the /labor/v1/shifts resource.

Add a Shift and Assign it to an Employee

curl -v -X POST \
-H "Authorization: Bearer eyJzI1NiJ9hbGciOiJSU.eyJhd9yaXR5Ij
oiQ1JVTkNIVElNRSIsInJzR3VpZCI6IjE4YzQ5YWJlLWFlODItNGFlYy04ND
M1LWJhYTRjMjVlYTY2MiIsInNjb3BlIjpbImxWQiOlsidG9hc3QiXSwibmFt
aW5nQXV0aGhYm9yIiwib3JkZXJzIiwidXNlcm1nbXQiXSwiZXhwIjoxNDg0M
zg5ODUwLCJqdGkiOiJlMDYzZjJkMy1jNGYyLTRiZjItODJmNi01MTg1NWMzZ
DAxM2YiLCJjbGllbnRfaWQiOiJjcnVuY2h0aW1lIn0.X1_0y9Hzj5F9gdOw2
o6VSYTyZwooAJiFMDmNakbZrtiUdYwLzuLwLpCMQzX5pKYtOqDUz_cetGJL3
txKL1L-K2j1Enoq8An8hEM6e8J0KdAiwrYFO3W3CmWedaoz95K9ghNZVCs28
Td2Sp3Ix3fObxbrvanocx9_OT8S9uM8hdSXmBI_ykTWvOVgK4hO24V3DJy4b
9bz1FtgOvrClhELxCe8dJy7jiwAR60xczlCF5rna98RMLN6zY4ffjmljKFZ6
QV0KkVppWjEiJn7oFHiIylCX1sSg7sddrGatj0xJzts3GJ8u8_lryUNHaEvJ
dWq4Yzwo007AMgxjH9d241Y-g" \
-H "Toast-Restaurant-External-ID: 4622e7a9-b4be-3fef-9220-b3dad273e0b4" \1
-H "Content-Type: application/json" \2
-d @my-shift-information.json \3
"https://[toast-api-hostname]/labor/v1/shifts"

1

Specify the GUID of the restaurant that you want to add a shift. This must be an individual restaurant, not the GUID for a restaurant group.

2

Specify the data type of the message body in the Content-Type header field. The value must be application/json.

3

Include information about the new employee in the message body of the POST request. This example curl command sends message body data from the contents of a file.


The following example shows the JSON message body data that provides information about the shift.

JSON Message Body Content to Add a Shift

{
  "employeeReference": {
    "entityType": "RestaurantUser",
    "guid": "0a7ced2c-b782-4585-8f41-4bb1656c3f67"1
  },
  "entityType": "Shift",2
  "inDate": "2017-01-13T06:00:00.000+0000",3
  "jobReference": {
    "entityType": "RestaurantJob",
    "guid": "a674499f-cddd-4b8b-a6b3-6d44147da330"4
  },
  "outDate": "2017-01-13T13:00:00.000+0000"5
}

1

Specify the GUID of the employee who will work the shift.

2

Specify the data type of the Toast POS input object. The value must be Shift.

3

Specify the date and time that the shift begins.

4

Specify the job for the shift in the jobReference value.

5

Specify the date and time that the shift ends.

The following example shows the JSON response data for a POST request to the /labor/v1/shifts resource.

Add Shift Response Data

{
  "guid": "08312056-c56f-4a10-a3c2-5660bf2b5143",1
  "entityType": "Shift",
  "externalId": null,
  "outDate": "2017-01-13T13:00:00.000+0000",
  "createdDate": "2016-12-29T05:33:16.712+0000",
  "deleted": false,
  "deletedDate": null,
  "employeeReference": {
    "guid": "0a7ced2c-b782-4585-8f41-4bb1656c3f67",
    "entityType": "RestaurantUser",
    "externalId": null
  },
  "modifiedDate": "2016-12-29T05:33:16.712+0000",
  "inDate": "2017-01-13T06:00:00.000+0000",
  "jobReference": {
    "guid": "a674499f-cddd-4b8b-a6b3-6d44147da330",
    "entityType": "RestaurantJob",
    "externalId": null
  }
}

1

The guid value contains the GUID value that the Toast POS assigns to the shift.