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.
Access to Toast APIs is controlled by the scopes that are associated with your API account. Toast API scopes and their capabilities are described below.
To see the scopes associated with your API client, you must decrypt the authentication token you receive after you request an authentication token. For more information about the contents of a Toast API authentication token, see Authentication return data for a partner API client and Authentication return data for a restaurant management group API client.
API |
Scope Type |
Scope Name |
Description |
---|---|---|---|
Cash management |
Read |
|
Allows reading from the cash management API. |
Configuration |
Read |
|
Allows reading from the configuration API. |
Credit cards |
Write |
|
Allows authorization of payments through the credit cards API. |
Kitchen |
Read |
|
Allows reading from the kitchen API. |
Labor |
Read |
|
Allows reading all data except employees from the labor API. |
Labor |
Read |
|
Allows reading employee information from the labor API. |
Labor |
Write |
|
Allows updating employee information in the labor API. |
Labor |
Write |
|
Allows updating job information in the labor API. |
Labor |
Write |
|
Allows updating shift information in the labor API. |
Menus |
Read |
|
Allows reading from the menus API. |
Order management configuration |
Read |
|
Allows reading from the order management configuration API. |
Orders |
Read |
|
Allows reading from the orders API with the exception of guest information. if
your API client creates orders, then to read orders, it must have
both the |
Orders |
Read |
|
Allows API clients that submit orders to the Toast platform to read from the orders API. To read orders, the API client must have
both the API clients that
have the |
Orders |
Read |
|
Allows reading guest delivery address information from the orders API. |
Orders |
Read |
|
Allows reading guest and curbside pickup information from the orders API. |
Orders |
Write |
|
Allows updating delivery information from the orders API. |
Orders |
Write |
|
Allows adding discounts to orders using the orders API. |
Orders |
Write |
|
Allows adding items to orders using the orders API. |
Orders |
Write |
|
Allows posting orders orders using the orders API. |
Orders |
Write |
|
Allows adding payments and tips to orders using the orders API. |
Restaurant availability Restaurants |
Read |
|
Allows reading from the restaurant availability API. Allows reading from the restaurants API. |
Stock |
Read |
|
Allows reading from the stock API. |
Stock |
Write |
|
Allows updating stock status for menu items (and modifier option item references) using the stock API. |