Skip to main content

Toast Component

Toast

Use the Toast component to manage Employees, Jobs, Cash Entries, and more.

Component key: toast

Description​

Toast is a cloud-based point-of-sale system designed specifically for the restaurant industry, offering tools for order management, payments, and business insights.

Use the component to manage Employees, Jobs, Cash Entries, and more.

API Documentation:​

The component was built using the Toast API Reference.

Connections​

Toast Client Credentials​

To authenticate via OAuth 2.0 You must provide a client identifier (clientId) and client secret (clientSecret) to the connection configuration of the integration. These may be obtained by requesting them from your Toast support team. Follow these guidelines when storing your API credentials.

InputNotesExample
API URL
string
/ Required
apiUrl
Your API URL for Toast.
https://toast-api-server.com
Client ID
string
/ Required
clientId
Client ID for Toast.
 
Client Secret
password
/ Required
clientSecret
Client Secret for Toast.
 

Triggers​

Webhook​

Receive and validate webhook requests from Toast for webhooks you configure. | key: webhook

InputNotesExample
Secret
string
/ Required
secret
The secret key for the webhook
mysecret

Data Sources​

Select Accessible Restaurant​

Select an accessible restaurant from a list of accessible restaurants. | key: selectAccessibleRestaurant | type: picklist

InputNotes
Connection
connection
/ Required
connection
 

Select Connected Restaurant​

Select a connected restaurant from a list of connected restaurants. | key: selectConnectedRestaurant | type: picklist

InputNotes
Connection
connection
/ Required
connection
 

Select Employee​

Select an employee from a list of employees. | key: selectEmployee | type: picklist

InputNotesExample
Connection
connection
/ Required
connection
 
 
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

Select Job​

Select a job from a list of jobs. | key: selectJob | type: picklist

InputNotesExample
Connection
connection
/ Required
connection
 
 
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

Select Shift​

Select a shift from a list of shifts. | key: selectShift | type: picklist

InputNotesExample
Connection
connection
/ Required
connection
 
 
End Date (Required)
string
/ Required
endDate
End date and time of time period to match shifts. A shift matches the time period if the shift inDate is after (inclusive) the specified Start Date and the shift Out Date is before the End Date (exclusive). The specified period cannot be longer than one month.
2015-10-10T12:00:00.000+0000
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012
Start Date (Required)
string
/ Required
startDate
Start date and time of time period to match shifts. A shift matches the time period if the shift inDate is after (inclusive) the specified Start Date and the shift Out Date is before the End Date (exclusive). The specified period cannot be longer than one month.
2015-10-10T06:00:00.000+0000

Actions​

Create Employee​

Creates a restaurant employee record. | key: createEmployee

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. This is a JSON object. See https://doc.toasttab.com/openapi/labor/tag/Data-definitions/schema/Employee/ for more information.
Chosen Name
string
chosenName
Optional, chosen name of the employee. To be used, when appropriate, in place of first name.
Johnny
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Email
string
/ Required
email
Employee's email address.
example@email.com
External Employee ID
string
externalEmployeeId
Optional, employee's external ID in the Toast platform.
12345678-1234-1234-1234-123456789012
External ID
string
externalId
External identifier string that is prefixed by the naming authority.
12345678-1234-1234-1234-123456789012
First Name
string
/ Required
firstName
First name of the employee.
John
Job References
code
jobReferences
An array of external references to jobs assigned to this employee. See https://doc.toasttab.com/openapi/labor/tag/Data-definitions/schema/Employee/ for more information.
Last Name
string
/ Required
lastName
Last name of the employee.
Doe
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012
Wage Overrides
code
wageOverrides
An optional array of per job wage overrides, where each element defines a job reference and the wage override for this employee when performing that job. See https://doc.toasttab.com/openapi/labor/tag/Data-definitions/schema/Employee/ for more information.

{
  "data": {
    "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": [
      {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      }
    ],
    "wageOverrides": [
      {
        "wage": 0,
        "jobReference": {
          "guid": "string",
          "entityType": "string",
          "externalId": "string"
        }
      }
    ],
    "v2EmployeeGuid": "string"
  }
}

Create Shift​

Creates a schedule shift for a restaurant employee. | key: createShift

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. This is a JSON object. See https://doc.toasttab.com/openapi/labor/tag/Data-definitions/schema/Shift/ for more information.
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Employee Reference
code
/ Required
employeeReference
A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID. See https://doc.toasttab.com/openapi/labor/tag/Data-definitions/schema/Shift/ for more information.
External ID
string
externalId
External identifier string that is prefixed by the naming authority.
MyToastNamingAuthority:1234
In Date
string
/ Required
inDate
Timestamp of the beginning of the shift. This is when the employee can clock in. Expressed in the UTC time zone.
2015-10-10T06:00:00.000+0000
Job Reference
code
jobReference
A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID. See https://doc.toasttab.com/openapi/labor/tag/Data-definitions/schema/Shift/ for more information.
Out Date
string
/ Required
outDate
Timestamp of the end of the shift. This is when the employee can clock out. Expressed in the UTC time zone.
2015-10-10T12:00:00.000+0000
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "deleted": true,
    "jobReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "employeeReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "inDate": "2019-08-24T14:15:22Z",
    "outDate": "2019-08-24T14:15:22Z",
    "scheduleConfig": {
      "guid": "string",
      "minBeforeClockIn": 0,
      "minAfterClockIn": 0,
      "minBeforeClockOut": 0,
      "minAfterClockOut": 0
    }
  }
}

Delete Employee​

Deletes a restaurant employee record by marking the record as deleted. | key: deleteEmployee

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Employee ID
string
/ Required
employeeId
The GUID of the employee to delete.
12345678-1234-1234-1234-123456789012
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

{
  "data": {
    "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": [
      {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      }
    ],
    "wageOverrides": [
      {
        "wage": 0,
        "jobReference": {
          "guid": "string",
          "entityType": "string",
          "externalId": "string"
        }
      }
    ],
    "v2EmployeeGuid": "string"
  }
}

Delete Shift​

Marks an existing schedule shift record for a restaurant employee as deleted. | key: deleteShift

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012
Shift ID
string
/ Required
shiftId
The shift identifier, either the Toast platform GUID or an external identifier.
12345678-1234-1234-1234-123456789012

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "deleted": true,
    "jobReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "employeeReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "inDate": "2019-08-24T14:15:22Z",
    "outDate": "2019-08-24T14:15:22Z",
    "scheduleConfig": {
      "guid": "string",
      "minBeforeClockIn": 0,
      "minAfterClockIn": 0,
      "minBeforeClockOut": 0,
      "minAfterClockOut": 0
    }
  }
}

Get Employee​

Returns an Employee object containing information about one restaurant employee. | key: getEmployee

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Employee ID
string
/ Required
employeeId
The GUID of the employee to retrieve.
12345678-1234-1234-1234-123456789012
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

{
  "data": {
    "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": [
      {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      }
    ],
    "wageOverrides": [
      {
        "wage": 0,
        "jobReference": {
          "guid": "string",
          "entityType": "string",
          "externalId": "string"
        }
      }
    ],
    "v2EmployeeGuid": "string"
  }
}

Get One Job​

Returns a Job object containing information about one employee job at a restaurant. | key: getOneJob

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Job ID
string
/ Required
jobId
The Toast platform GUID or an external identifier for the job.
12345678-1234-1234-1234-123456789012
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "title": "string",
    "deleted": true,
    "wageFrequency": "HOURLY",
    "defaultWage": 0,
    "tipped": true,
    "code": "string",
    "excludeFromReporting": true
  }
}

Get Shift​

Performs Get Shift | key: getShift

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012
Shift ID
string
/ Required
shiftId
The shift identifier, either the Toast platform GUID or an external identifier.
12345678-1234-1234-1234-123456789012

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "deleted": true,
    "jobReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "employeeReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "inDate": "2019-08-24T14:15:22Z",
    "outDate": "2019-08-24T14:15:22Z",
    "scheduleConfig": {
      "guid": "string",
      "minBeforeClockIn": 0,
      "minAfterClockIn": 0,
      "minBeforeClockOut": 0,
      "minAfterClockOut": 0
    }
  }
}

Get Time Entry​

Returns a TimeEntry object containing information about one employee shift. | key: getTimeEntry

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Include Archived
boolean
includeArchived
false
Controls whether the response includes an archived time entry.
 
Include Missed Breaks
boolean
includeMissedBreaks
false
Indicate whether missed breaks should be returned in the breaks array for the time entries.
 
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012
Time Entry ID
string
/ Required
timeEntryId
The Toast platform GUID or an external identifier for the time entry.
12345678-1234-1234-1234-123456789012

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "deleted": true,
    "jobReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "employeeReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "shiftReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "inDate": "2019-08-24T14:15:22Z",
    "outDate": "2019-08-24T14:15:22Z",
    "autoClockedOut": true,
    "businessDate": "string",
    "regularHours": 0,
    "overtimeHours": 0,
    "hourlyWage": 0,
    "breaks": [
      {
        "guid": "string",
        "breakType": {
          "guid": "string",
          "entityType": "string"
        },
        "paid": true,
        "inDate": "2019-08-24T14:15:22Z",
        "outDate": "2019-08-24T14:15:22Z",
        "missed": true,
        "auditResponse": true
      }
    ],
    "declaredCashTips": 0,
    "nonCashTips": 0,
    "cashGratuityServiceCharges": 0,
    "nonCashGratuityServiceCharges": 0,
    "tipsWithheld": 0,
    "nonCashSales": 0,
    "cashSales": 0
  }
}

List Accessible Restaurants​

Returns an array of PartnerAccessExternalRep objects that contain information about the Toast restaurants that your partner API client can access. | key: listAccessibleRestaurants

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Last Modified
string
lastModified
Limits the return data to restaurants that changed their access configuration for a partner API client after a specific date and time.
2020-03-01T00:00:00.000-0000

{
  "data": [
    {
      "restaurantGuid": "e728cd53-2fa7-4e63-8f8f-93e78ea66b03",
      "managementGroupGuid": "bdfda703-2a83-4e0f-9b8a-8ea0ee6cab79",
      "deleted": true,
      "restaurantName": "Main Street Cafe",
      "locationName": "123 Main Street",
      "createdByEmailAddress": "clefebvre@mainstreetcafe.com",
      "externalGroupRef": "string",
      "externalRestaurantRef": "string",
      "modifiedDate": 1678846869551,
      "createdDate": 1643858534451,
      "isoModifiedDate": "2023-03-12T08:32:34.008Z",
      "isoCreatedDate": "2022-05-17T10:21:38.008Z"
    }
  ]
}

List Cash Entries​

Returns information about cash added to or removed from a cash drawer or other cash storage device. | key: listCashEntries

InputDefaultNotesExample
Business Date
string
/ Required
businessDate
The business date the cash entries were created, in the format yyyymmdd.
20180228
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "amount": 0,
      "reason": "string",
      "date": "2019-08-24T14:15:22Z",
      "type": "CASH_IN",
      "cashDrawer": {
        "guid": "string",
        "entityType": "string"
      },
      "payoutReason": {
        "guid": "string",
        "entityType": "string"
      },
      "noSaleReason": {
        "guid": "string",
        "entityType": "string"
      },
      "undoes": "string",
      "employee1": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "employee2": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "creatorOrShiftReviewSubject": {
        "guid": "string",
        "entityType": "string"
      },
      "approverOrShiftReviewSubject": {
        "guid": "string",
        "entityType": "string"
      }
    }
  ]
}

List Connected Restaurants​

Returns a PaginatedResponse object that contains a paginated array of the restaurants that have connected to your integrated partner service. | key: listConnectedRestaurants

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Last Modified
string
lastModified
Limits the return data to restaurants that changed their access configuration for your partner service after a specific date and time. You can use this parameter to identify new or updated restaurants connected to your partner service.
2020-03-01T00:00:00.000-0000
Page Size
string
pageSize
100
Controls the number of PartnerAccessExternalRep objects that the endpoint will return in each page of response data. The maximum page size is 200.
100
Page Token
string
pageToken
Returns a specific set of restaurants in the response value. You get the token string for the next page of connected restaurants from the nextPageToken value of the PaginatedResponse object for a page of results.
cDoyLHM6MQ==

{
  "data": [
    {
      "currentPageNum": 1,
      "results": [
        {
          "restaurantGuid": "7ab295f6-8dc8-4cb6-8cdb-072b83e84184",
          "managementGroupGuid": "75063706-dd6e-4da6-8bb6-3a99e218e686",
          "restaurantName": "Main Street Cafe",
          "locationName": "123 Main Street",
          "createdByEmailAddress": "clefebvre@mainstreetcafe.com",
          "externalGroupRef": null,
          "externalRestaurantRef": null,
          "modifiedDate": 1678823073353,
          "createdDate": 1678823073353,
          "isoModifiedDate": "2023-03-14T19:44:33.353Z",
          "isoCreatedDate": "2023-03-14T19:44:33.353Z"
        }
      ],
      "totalResultCount": 3222,
      "pageSize": 1,
      "currentPageToken": "cDoxLHM6MQ==",
      "nextPageToken": "cDoyLHM6MQ==",
      "totalCount": 3222,
      "nextPageNum": 2,
      "lastPageNum": 3222,
      "previousPageNum": null
    }
  ]
}

List Deposits​

Returns an array of Deposit objects containing information about cash removed from a restaurant to be deposited in a bank or other financial institution during one business day. | key: listDeposits

InputDefaultNotesExample
Business Date
string
/ Required
businessDate
The business date the deposits were created, in the format yyyymmdd.
20180228
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "amount": 0,
      "date": "2019-08-24T14:15:22Z",
      "undoes": "string",
      "employee": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "creator": {
        "guid": "string",
        "entityType": "string"
      }
    }
  ]
}

List Employees​

Returns an array of Employee objects containing information about restaurant employees. | key: listEmployees

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Employee IDs
string
Value List
employeeIds
An optional identifier that filters return values for a specific employee. The identifier can be a Toast platform GUID or an external identifier.
12345678-1234-1234-1234-123456789012
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

{
  "data": [
    {
      "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": [
        {
          "guid": "string",
          "entityType": "string",
          "externalId": "string"
        }
      ],
      "wageOverrides": [
        {
          "wage": 0,
          "jobReference": {
            "guid": "string",
            "entityType": "string",
            "externalId": "string"
          }
        }
      ],
      "v2EmployeeGuid": "string"
    }
  ]
}

List Jobs​

Returns an array of Job objects containing information about the employee jobs configured at a restaurant. | key: listJobs

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Job IDs
string
Value List
jobIds
An optional job identifier, either the Toast platform GUID or an external identifier assigned by the client.
12345678-1234-1234-1234-123456789012
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "externalId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "deletedDate": "2019-08-24T14:15:22Z",
      "title": "string",
      "deleted": true,
      "wageFrequency": "HOURLY",
      "defaultWage": 0,
      "tipped": true,
      "code": "string",
      "excludeFromReporting": true
    }
  ]
}

List Shifts​

Returns an array of Shift objects that contain information about schedule shifts for restaurant employees. | key: listShifts

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
End Date
string
endDate
Optional end date and time of time period to match shifts. A shift matches the time period if the shift inDate is after (inclusive) the specified Start Date and the shift Out Date is before the End Date (exclusive). These parameters are required if the shiftIds parameter is not defined. The specified period cannot be longer than one month.
2015-10-10T12:00:00.000+0000
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012
Shift IDs
string
Value List
shiftIds
An optional identifier that filters return values for a specific shift. The identifier can be a Toast platform GUID or an external identifier. If present, the shifts resource will only return the shifts you specify.
12345678-1234-1234-1234-123456789012
Start Date
string
startDate
Optional start date and time of time period to match shifts. A shift matches the time period if the shift inDate is after (inclusive) the specified Start Date and the shift Out Date is before the End Date (exclusive). These parameters are required if the Shift Ids input is not defined. The specified period cannot be longer than one month.
2015-10-10T06:00:00.000+0000

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "externalId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "deletedDate": "2019-08-24T14:15:22Z",
      "deleted": true,
      "jobReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "employeeReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "inDate": "2019-08-24T14:15:22Z",
      "outDate": "2019-08-24T14:15:22Z",
      "scheduleConfig": {
        "guid": "string",
        "minBeforeClockIn": 0,
        "minAfterClockIn": 0,
        "minBeforeClockOut": 0,
        "minAfterClockOut": 0
      }
    }
  ]
}

List Time Entries​

Returns an array of Time Entry objects that contain information about employee shift events. | key: listTimeEntries

InputDefaultNotesExample
Business Date
string
businessDate
Optional date to match time entries. A time entry matches the business date if its clock-in inDate is during the business date. The cutoff from one Business Date to the next is the Closeout Hour for the restaurant.
20180228
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
End Date
string
endDate
The end date and time of the time period to match time entries. A time entry matches the time period if its clock-in inDate is after (inclusive) the specified Start Date and before (exclusive) the End Date. The specified period cannot be longer than one month.
2018-02-28T23:59:59Z
Include Archived
boolean
includeArchived
false
Controls whether the response includes archived time entries, when using the Start Date and End Date parameters.
 
Include Missed Breaks
boolean
includeMissedBreaks
false
Indicate whether missed breaks should be returned in the breaks array for the time entries.
 
Modified End Date
string
modifiedEndDate
The end date and time of the time period to match modified time entries. A time entry matches the time period if that entry was modified before (exclusive) the Modified End Date. If you include this parameter, you must also include the Modified Start Date parameter. The specified period cannot be longer than one month.
2018-02-28T23:59:59Z
Modified Start Date
string
modifiedStartDate
The start date and time of the time period to match modified time entries. A time entry matches the time period if that entry was modified after (inclusive) the Modified Start Date. If you include this parameter, you must also include the Modified End Date parameter. The specified period cannot be longer than one month.
2018-02-28T00:00:00Z
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012
Start Date
string
startDate
The start date and time of the time period to match time entries. A time entry matches the time period if its clock-in inDate is after (inclusive) the specified Start Date and before (exclusive) the End Date. The specified period cannot be longer than one month.
2018-02-28T00:00:00Z
Time Entry IDs
string
Value List
timeEntryIds
A time entry identifier, either the Toast platform GUID or an external identifier.
12345678-1234-1234-1234-123456789012

{
  "data": [
    {
      "guid": "string",
      "entityType": "string",
      "externalId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "deletedDate": "2019-08-24T14:15:22Z",
      "deleted": true,
      "jobReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "employeeReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "shiftReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      },
      "inDate": "2019-08-24T14:15:22Z",
      "outDate": "2019-08-24T14:15:22Z",
      "autoClockedOut": true,
      "businessDate": "string",
      "regularHours": 0,
      "overtimeHours": 0,
      "hourlyWage": 0,
      "breaks": [
        {
          "guid": "string",
          "breakType": {
            "guid": "string",
            "entityType": "string"
          },
          "paid": true,
          "inDate": "2019-08-24T14:15:22Z",
          "outDate": "2019-08-24T14:15:22Z",
          "missed": true,
          "auditResponse": true
        }
      ],
      "declaredCashTips": 0,
      "nonCashTips": 0,
      "cashGratuityServiceCharges": 0,
      "nonCashGratuityServiceCharges": 0,
      "tipsWithheld": 0,
      "nonCashSales": 0,
      "cashSales": 0
    }
  ]
}

Raw Request​

Send raw HTTP request to Toast. | key: rawRequest

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Data
string
data
The HTTP body payload to send to the URL.
{"exampleKey": "Example Data"}
Debug Request
boolean
debugRequest
false
Enabling this flag will log out the current request.
 
File Data
string
Key Value List
fileData
File Data to be sent as a multipart form upload.
[{key: "example.txt", value: "My File Contents"}]
File Data File Names
string
Key Value List
fileDataFileNames
File names to apply to the file data inputs. Keys must match the file data keys above.
 
Form Data
string
Key Value List
formData
The Form Data to be sent as a multipart form upload.
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header
string
Key Value List
headers
A list of headers to send with the request.
User-Agent: curl/7.64.1
Max Retry Count
string
maxRetries
0
The maximum number of retries to attempt. Specify 0 for no retries.
 
Method
string
/ Required
method
The HTTP method to use.
 
Query Parameter
string
Key Value List
queryParams
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
 
Response Type
string
/ Required
responseType
json
The type of data you expect in the response. You can request json, text, or binary data.
 
Retry On All Errors
boolean
retryAllErrors
false
If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
 
Retry Delay (ms)
string
retryDelayMS
0
The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
 
Timeout
string
timeout
The maximum time that a client will await a response to its request
2000
URL
string
/ Required
url
Input the path only (/partners/v1/restaurants), The base URL is already included (https://toast-api-server). For example, to connect to https://toast-api-server/partners/v1/restaurants, only /partners/v1/restaurants is entered in this field.
/partners/v1/restaurants
Use Exponential Backoff
boolean
useExponentialBackoff
false
Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.
 

Update Employee​

Performs Update Employee | key: updateEmployee

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. This is a JSON object. See https://doc.toasttab.com/openapi/labor/tag/Data-definitions/schema/Employee/ for more information.
Chosen Name
string
chosenName
Optional, chosen name of the employee. To be used, when appropriate, in place of first name.
Johnny
Connection
connection
/ Required
connection
 
 
 
Current Passcode
string
currentPasscode
The employee's current passcode. Required when updating the passcode.
1234
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Employee ID
string
/ Required
employeeId
The GUID of the employee to delete.
12345678-1234-1234-1234-123456789012
External Employee ID
string
externalEmployeeId
Optional, employee's external ID in the Toast platform.
12345678-1234-1234-1234-123456789012
First Name
string
firstName
First name of the employee.
John
Last Name
string
lastName
Last name of the employee.
Doe
Passcode
string
passcode
The passcode for access to Toast POS devices. When updating the passcode, you must include the current passcode in the Current Passcode value.
1234
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012

{
  "data": {
    "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": [
      {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      }
    ],
    "wageOverrides": [
      {
        "wage": 0,
        "jobReference": {
          "guid": "string",
          "entityType": "string",
          "externalId": "string"
        }
      }
    ],
    "v2EmployeeGuid": "string"
  }
}

Update Shift​

Updates an existing schedule shift record for a restaurant employee. | key: updateShift

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. This is a JSON object. See https://doc.toasttab.com/openapi/labor/tag/Data-definitions/schema/Shift/ for more information.
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Employee Reference
code
/ Required
employeeReference
A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID. See https://doc.toasttab.com/openapi/labor/tag/Data-definitions/schema/Shift/ for more information.
In Date
string
/ Required
inDate
Timestamp of the beginning of the shift. This is when the employee can clock in. Expressed in the UTC time zone.
2015-10-10T06:00:00.000+0000
Job Reference
code
jobReference
A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID. See https://doc.toasttab.com/openapi/labor/tag/Data-definitions/schema/Shift/ for more information.
Out Date
string
/ Required
outDate
Timestamp of the end of the shift. This is when the employee can clock out. Expressed in the UTC time zone.
2015-10-10T12:00:00.000+0000
Restaurant External ID
string
/ Required
restaurantExternalId
The GUID of the restaurant that is the context of the request. Use the List Accessible Restaurants action to get the external ID of a restaurant.
12345678-1234-1234-1234-123456789012
Shift ID
string
/ Required
shiftId
The shift identifier, either the Toast platform GUID or an external identifier.
12345678-1234-1234-1234-123456789012

{
  "data": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "deletedDate": "2019-08-24T14:15:22Z",
    "deleted": true,
    "jobReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "employeeReference": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "inDate": "2019-08-24T14:15:22Z",
    "outDate": "2019-08-24T14:15:22Z",
    "scheduleConfig": {
      "guid": "string",
      "minBeforeClockIn": 0,
      "minAfterClockIn": 0,
      "minBeforeClockOut": 0,
      "minAfterClockOut": 0
    }
  }
}