Access Scopes
An OAuth access token can have a variety of permission levels for access to data in an account. This is called the scope. When requesting a token using your K-Series OAuth client, you will only be able to request the specific access scopes required by your integration.
List of Scopes
See the below table for the full list of access scopes:
| Scope | Description |
|---|---|
orders-api | Read business information, floors, menus, discounts, and production instructions. Read and write orders and payments. Read Rich Item data. |
financial-api | Read financial data. |
items | Read and write items. |
propertymanagement | Read and write Property Management System configurations. |
staff-api | Read staff and shift details. Configure webhooks. |
reservations-*** | Platform reservations scope. The *** will be replaced by the platform-code of your reservation platform. |
reservations-api | Configure legacy reservation integrations. Note: This API will eventually be deprecated in favour of the new Reservations for Platforms API. More information on the new reservations workflows can be found in the Integration Guide. |
Approving Scopes
During the authorization flow, the user must approve each scope individually.
Example:
