Scopes
Scopes decide which modules and operations a token can reach. Request only what your app needs.
Format
Scalar360.<module>.<operation>
Scalar360.invoices.READ
Scalar360.customers.ALL
Scalar360.fullaccess.ALL| Operation | Allows |
|---|---|
READ | GET requests |
CREATE | POST requests |
UPDATE | PUT and PATCH requests |
DELETE | DELETE requests |
ALL | All of the above for the module |
The module is the first path segment after the version: /api/v1/invoices/… needs an invoices scope and /api/crm/leads/… a crm scope. Every endpoint in the API reference shows the exact scope it needs. Separate several scopes with commas. Scope names are case-insensitive.
Scalar360.fullaccess.ALL grants every module except settings. Prefer specific scopes — users see exactly what you ask for on the consent screen.Users, invitations and settings
Managing team members, invitations, roles and permissions, and changing organisation settings, needs the settings scope — for example Scalar360.settings.READ or Scalar360.settings.ALL. It is never included in Scalar360.fullaccess.ALL, so an app has to ask for it explicitly. Reading the organisations a user belongs to (GET /api/v1/organizations and GET /api/v1/organizations/{id}) works with any scope.
Never available
Some areas can't be reached with any scope: sign-in and accounts (passwords, two-step sign-in, passkeys, sessions), billing, payments and subscriptions, switching or creating organisations, accepting invitations, AI and developer settings, and the employee self-service portal. These return 403 FORBIDDEN_RESOURCE.
A token without the right scope gets 401 INVALID_SCOPE, and the message names the scope required.
All modules
| Module | Scope prefix | Endpoints |
|---|---|---|
| Accounting | Scalar360.accounting.* | 60 |
| Assets | Scalar360.assets.* | 40 |
| Audit log | Scalar360.audit-log.* | 1 |
| Batches | Scalar360.batches.* | 4 |
| Bills | Scalar360.bills.* | 17 |
| Composite items | Scalar360.composite-items.* | 5 |
| Contacts | Scalar360.contacts.* | 16 |
| Credit notes | Scalar360.credit-notes.* | 10 |
| CRM | Scalar360.crm.* | 45 |
| Current user | Scalar360.me.* | 15 |
| Custom fields | Scalar360.custom-fields.* | 9 |
| Customers | Scalar360.customers.* | 5 |
| Dashboard data | Scalar360.dashboard-data.* | 3 |
| Daybook | Scalar360.daybook.* | 2 |
| Document email settings | Scalar360.document-email-settings.* | 2 |
| Document emails | Scalar360.document-emails.* | 1 |
| Documents | Scalar360.documents.* | 4 |
| Drive | Scalar360.drive.* | 49 |
| Email templates | Scalar360.email-templates.* | 5 |
| Expense categories | Scalar360.expense-categories.* | 5 |
| Expenses | Scalar360.expenses.* | 27 |
| Health | Scalar360.health.* | 1 |
| Hooks | Scalar360.hooks.* | 1 |
| Import jobs | Scalar360.import-jobs.* | 5 |
| Integrations | Scalar360.integrations.* | 21 |
| Inventory | Scalar360.inventory.* | 47 |
| Inventory adjustments | Scalar360.inventory-adjustments.* | 4 |
| Invoices | Scalar360.invoices.* | 21 |
| Leads | Scalar360.leads.* | 39 |
| Manufacturing | Scalar360.manufacturing.* | 47 |
| Notifications | Scalar360.notifications.* | 12 |
| Payables | Scalar360.payables.* | 4 |
| Payroll | Scalar360.payroll.* | 144 |
| Plans | Scalar360.plans.* | 2 |
| Point of sale | Scalar360.pos.* | 34 |
| Price lists | Scalar360.price-lists.* | 5 |
| Projects | Scalar360.projects.* | 382 |
| Purchase | Scalar360.purchase.* | 1 |
| Purchase debit notes | Scalar360.purchase-debit-notes.* | 11 |
| Purchase orders | Scalar360.purchase-orders.* | 5 |
| Purchase receipts | Scalar360.purchase-receipts.* | 6 |
| Purchase returns | Scalar360.purchase-returns.* | 5 |
| Quotes | Scalar360.quotes.* | 8 |
| Receivables | Scalar360.receivables.* | 4 |
| Recurring | Scalar360.recurring.* | 8 |
| Reorder | Scalar360.reorder.* | 3 |
| Reports | Scalar360.reports.* | 36 |
| Sales | Scalar360.sales.* | 3 |
| Sales orders | Scalar360.sales-orders.* | 7 |
| Sales returns | Scalar360.sales-returns.* | 4 |
| Settings | Scalar360.settings.* | 21 |
| Shipments | Scalar360.shipments.* | 8 |
| Stock | Scalar360.stock.* | 1 |
| Stock transfers | Scalar360.stock-transfers.* | 8 |
| Supply chain | Scalar360.scm.* | 6 |
| Table views | Scalar360.table-views.* | 3 |
| Todos | Scalar360.todos.* | 5 |
| User preferences | Scalar360.user-preferences.* | 3 |
| Vendors | Scalar360.vendors.* | 7 |
