Skip to main content

Scopes

API keys carry an explicit list of scopes. Missing a scope returns 403.

ScopeAccess
cases:readList/get cases
cases:writeCreate cases, complete wizard, POST /cases/short-term
documents:readList/get documents and download content
documents:writeUpload documents to a case
people:readList/get people, including nested permits, certificates, and case summaries

Grant the least privilege your integration needs. Nested permit and certificate data on people requires people:read only — there are no separate permits:* or certificates:* scopes.

Webhooks are managed in Admin → Developers by signed-in users; they are not controlled by API-key scopes.