v1.0.0
Scopes
Permissions your AIP asks the merchant for.
Ask for the smallest set of scopes that makes your AIP work. Reviewers reject AIPs that request scopes they do not use.
Resource scopes
| Resource | Scopes | Covers |
|---|---|---|
company | company:read, company:write | Company profile, TIN and branding. |
users | users:read, users:write | Workspace members. |
invoices | invoices:read, invoices:write | Invoices and receipts. |
products | products:read, products:write | Products and services. |
inventory | inventory:read, inventory:write | Stock levels and movements. |
buyers | buyers:read, buyers:write | Customers. |
files | files:read, files:write | Uploaded files. |
tickets | tickets:read, tickets:write, tickets:admin | Projects, tickets, boards and SLAs. |
hr | hr:read, hr:write, hr:admin, hr:self | Employees, leave and attendance. self limits access to the signed-in employee. |
payroll | payroll:read, payroll:write, payroll:admin | Payroll runs and payslips. |
Platform scopes
| Scope | Covers |
|---|---|
events:subscribe | Live events through client.api.subscribe and worker webhooks. |
ui:overlay | Rendering on the overlay surface. |
state:read | Reading your per-workspace key-value state. |
state:write | Writing your per-workspace key-value state. |
Requesting optional scopes
if (!client.init?.grantedScopes.includes('inventory:read')) {
client.requestScopes(['inventory:read']);
}