Overview / Scopes
Scopes
A key reaches exactly the endpoints its scopes cover — nothing more. There is no
"full access" default: a key with no scopes can call /status and
nothing else.
read and write are granted separately, so a reporting
integration never gets the ability to change the menu. Operations that move
money or grant access (customer balance, payroll, roles, subscription) have
their own scopes for the same reason.
Calling an endpoint you lack returns insufficient_scope, listing
the missing scope by name so you know which checkbox to tick in the panel.
Operations
| dashboard.read | Read dashboard summaries |
| branches.read | Read branches |
| branches.write | Create, update and delete branches |
| shifts.read | Read shifts and assignments |
| shifts.write | Plan shifts and assign staff |
| checklists.read | Read checklists and submissions |
| checklists.write | Create and update checklists |
| checklists.submit | Submit checklist answers |
| audits.read | Read audit results |
| audits.write | Create and close audit actions |
| devices.read | Read device fleet |
| devices.write | Register and update devices |
Catalog
| products.read | Read products |
| products.write | Create, update and delete products |
| categories.read | Read product categories |
| categories.write | Manage product categories |
| recipes.read | Read recipes |
| recipes.write | Create and update recipes |
| addons.read | Read addon groups and addons |
| addons.write | Manage addon groups and addons |
| campaigns.read | Read campaigns |
| campaigns.write | Create and update campaigns |
| coupons.read | Read coupons |
| coupons.write | Create and update coupons |
| languages.read | Read languages and translations |
| languages.write | Manage languages and write translations |
Sales & cash
| orders.read | Read orders |
| orders.write | Create orders |
| orders.payment | Collect payment for orders awaiting payment |
| kitchen.write | Move orders through kitchen stages |
| orders.refund | Void and refund orders |
| cash.read | Read cash records and day-end reports |
| cash.write | Open and close the cash day |
| pos.cashiers.read | Read cashiers and POS PIN hashes |
| tables.read | Read tables and open bills |
| tables.write | Open tables, send orders and settle bills |
| reservations.read | Read table reservations |
| reservations.write | Create, update and cancel reservations |
Stock & supply
| stock.read | Read stock levels and movements |
| stock.write | Adjust stock and post movements |
| stock_items.read | Read stock items, categories and units |
| stock_items.write | Manage stock items, categories and units |
| stock_counts.read | Read stock counts |
| stock_counts.write | Create and post stock counts |
| assets.read | Read assets |
| assets.write | Create and edit assets |
| assets.count | Run asset counts |
| warehouses.read | Read warehouses and warehouse stock |
| warehouses.write | Manage warehouses and warehouse stock |
| warehouse_requests.read | Read warehouse requests |
| warehouse_requests.write | Create and fulfil warehouse requests |
| transfers.read | Read branch transfers |
| transfers.write | Create and receive branch transfers |
| goods_receipts.read | Read goods receipts |
| goods_receipts.write | Create goods receipts |
| purchases.read | Read purchase orders |
| purchases.write | Create and manage purchase orders |
| suppliers.read | Read suppliers |
| suppliers.write | Manage suppliers |
People & HR
| employees.read | Read employees |
| employees.write | Create and update employees |
| leaves.read | Read leave requests |
| leaves.write | Create and decide leave requests |
| payroll.read | Read salaries, payrolls and expenses |
| payroll.write | Set salaries and run payroll |
Customers & loyalty
| customers.read | Read customers |
| customers.write | Create and update customers |
| customers.wallet | Adjust customer balance and points |
| loyalty.read | Read loyalty rules |
| loyalty.write | Change loyalty rules |
Finance
| transactions.read | Read income and expense entries |
| transactions.write | Create income and expense entries |
| payment_methods.read | Read payment methods |
| payment_methods.write | Manage payment methods |
| reports.read | Read and download reports |
| reports.write | Generate and schedule reports |
Kiosk
| kiosk.read | Read kiosk themes |
| kiosk.write | Edit and publish kiosk themes |
System
| users.read | Read panel users |
| users.write | Invite users and change their access |
| roles.read | Read roles and permissions |
| roles.write | Manage roles and permissions |
| webhooks.read | Read webhook subscriptions |
| webhooks.write | Manage webhook subscriptions |
| settings.read | Read brand settings |
| settings.write | Change brand settings |
| billing.read | Read subscription and invoices |
| billing.write | Change the subscription plan |
| activity.read | Read the activity log |