Skip to main content

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.

During the authorization flow, the user must approve each scope individually.

Example​

Scopes

See the below table for the full list of access scopes:

ScopeDescription
orders-apiRead business information, floors, menus, discounts, and production instructions. Read and write orders and payments.
financial-apiRead financial data.
reservations-apiRead and write webhooks. Update Reservation statuses. Configure reservation integrations.
itemsRead and write items. Read rich items.
propertymanagementRead and write Property Management System configurations.