What each scope allows
Which scope a key needs for each call of the API.
Each key carries one or more scopes. A call that needs a scope the key does not have gets 403 forbidden with details.reason missing_scope, and details.scope names the scope that is missing.
In the New key form, each scope is one box: See is the read scope of an area and Change is its write scope.
| Scope | What it covers |
|---|---|
| products:read | Listing and reading products, orders, imports and the coverage report. |
| products:write | Creating, updating and cancelling products, running imports and reporting sync runs. |
| reviews:write | Approving models and requesting changes. |
| assets:read | Reading assets and images. |
| webhooks:manage | Managing webhook subscriptions and deliveries. |
| account:read | Reading the account: the plan, usage per kind, allowances and the billing currency. |
| jobs:read | Reading jobs, render presets and styles. |
| jobs:write | Starting and cancelling jobs. |
| settings:write | Naming templates. |
The scope each call needs
A filled mark shows the scope a call needs. GET /api/v1/me needs no scope: any valid key may call it.