Scopes
API keys carry an explicit list of scopes. Missing a scope returns 403.
| Scope | Access |
|---|---|
cases:read | List/get cases and assignments |
cases:write | Create cases, complete wizard, short-term and company-certification starts |
documents:read | List/get documents and download content |
documents:write | Upload documents to a case |
people:read | List/get people (employees) |
permits:read | List/get issued permits |
certificates:read | List/get certificates |
webhooks:read | List webhooks (API-key authenticated) |
webhooks:write | Create/update/delete webhooks |
Grant the least privilege your integration needs. Reading permits does not require cases:write.