Scopes

Scopes control what a token can access. Each scope follows the resource:action format (e.g. orders:read). The scopes available to a token depend on the token type and what was granted to your connector during registration.

How scopes work

• When requesting a token via POST /oauth/token, you can optionally pass a scope parameter with a space-separated list of scopes
• If omitted, the token includes all scopes your client is allowed
• If you request a scope not in your client's allowed list, the response is invalid_scope
• Scopes are enforced on every API call — a 403 with missing_scopes means the token lacks the required scope

Company-level scopes

Available with a Company Token (include company_id in the token request).

Scope	Description
menu:read	Read menu categories and products
menu:write	Create and update products
orders:read	Read orders
orders:write	Create orders, update order status, items, payments and discounts, and cancel orders
promotions:read	Read active promotions and coupons
promotions:write	Create, update, and delete promotions (coupons)
clients:read	Read client list with filters and pagination
clients:write	Create and update clients
addresses:read	List client delivery addresses
addresses:write	Create, update, and delete client delivery addresses
reports:read	Read reports
webhooks:read	List and view webhook configurations
webhooks:write	Create, update, and delete webhooks
companies:read	Read company information
payment-methods:read	Read the company payment methods
stores:read	Read food-app store open/closed status
users:read	Read the company user list with role filter and pagination
fiscal-notes:write	Create and update fiscal note invoices
logistics:write	Assign riders and update delivery status
cashiers:read	Read cash register openings and closings

Connector-level scopes

Available with a Connector Token (omit company_id from the token request).

Scope	Description
conections:read	List connector conections
conections:write	Update conection status
portfolio:read	Read the connector portfolio of companies on the qualifying plan