Scopes & Permissions
API keys are scoped to specific resources and access levels. Scopes are immutable after creation — to change scopes, revoke the old key and create a new one.
| Scope | Grants Access To |
|---|---|
read:products | GET /products, GET /products/:id |
write:products | POST, PUT, DELETE /products |
read:designs | GET /designs, GET /designs/:id |
write:designs | POST, PUT, DELETE /designs |
read:patterns | GET /patterns, GET /patterns/:id |
write:patterns | POST, PUT, DELETE /patterns |
read:quotes | GET /quotes, GET /quotes/:id, GET /quotes/:id/assets, GET /quotes/:id/roster |
write:quotes | POST /quotes, POST /quotes/:groupId/revisions, PUT /quotes/:groupId/roster |
read:quote-groups | GET /quote-groups, GET /quote-groups/:id |
write:quote-groups | PUT /quote-groups/:id/status, DELETE /quote-groups/:id |
read:mockups | GET /mockups, GET /mockups/:id |
read:colors | GET /colors |
read:fabrics | GET /fabrics |
read:fonts | GET /fonts |
Shorthand scopes: read grants all read scopes, write grants all write scopes (implies read), full grants everything.
Example key scopes (JSON)
{
"scopes": [
"read:products",
"read:quotes",
"write:quotes"
]
}