Developer docs menu

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
OperationAllows
READGET requests
CREATEPOST requests
UPDATEPUT and PATCH requests
DELETEDELETE requests
ALLAll 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

ModuleScope prefixEndpoints
AccountingScalar360.accounting.*60
AssetsScalar360.assets.*40
Audit logScalar360.audit-log.*1
BatchesScalar360.batches.*4
BillsScalar360.bills.*17
Composite itemsScalar360.composite-items.*5
ContactsScalar360.contacts.*16
Credit notesScalar360.credit-notes.*10
CRMScalar360.crm.*45
Current userScalar360.me.*15
Custom fieldsScalar360.custom-fields.*9
CustomersScalar360.customers.*5
Dashboard dataScalar360.dashboard-data.*3
DaybookScalar360.daybook.*2
Document email settingsScalar360.document-email-settings.*2
Document emailsScalar360.document-emails.*1
DocumentsScalar360.documents.*4
DriveScalar360.drive.*49
Email templatesScalar360.email-templates.*5
Expense categoriesScalar360.expense-categories.*5
ExpensesScalar360.expenses.*27
HealthScalar360.health.*1
HooksScalar360.hooks.*1
Import jobsScalar360.import-jobs.*5
IntegrationsScalar360.integrations.*21
InventoryScalar360.inventory.*47
Inventory adjustmentsScalar360.inventory-adjustments.*4
InvoicesScalar360.invoices.*21
LeadsScalar360.leads.*39
ManufacturingScalar360.manufacturing.*47
NotificationsScalar360.notifications.*12
PayablesScalar360.payables.*4
PayrollScalar360.payroll.*144
PlansScalar360.plans.*2
Point of saleScalar360.pos.*34
Price listsScalar360.price-lists.*5
ProjectsScalar360.projects.*382
PurchaseScalar360.purchase.*1
Purchase debit notesScalar360.purchase-debit-notes.*11
Purchase ordersScalar360.purchase-orders.*5
Purchase receiptsScalar360.purchase-receipts.*6
Purchase returnsScalar360.purchase-returns.*5
QuotesScalar360.quotes.*8
ReceivablesScalar360.receivables.*4
RecurringScalar360.recurring.*8
ReorderScalar360.reorder.*3
ReportsScalar360.reports.*36
SalesScalar360.sales.*3
Sales ordersScalar360.sales-orders.*7
Sales returnsScalar360.sales-returns.*4
SettingsScalar360.settings.*21
ShipmentsScalar360.shipments.*8
StockScalar360.stock.*1
Stock transfersScalar360.stock-transfers.*8
Supply chainScalar360.scm.*6
Table viewsScalar360.table-views.*3
TodosScalar360.todos.*5
User preferencesScalar360.user-preferences.*3
VendorsScalar360.vendors.*7