Skip to content

DevelopersGet started

Scopes

A scope is one permission, like calls:read. You pick a key's scopes when you create it, and its tokens can do only what those scopes allow. A request without the right scope fails with 403 insufficient_scope, whatever else the key can do.

On this page

Choosing scopes

  • Start read-only. The Developers page has a Read-only preset; add :write scopes only for what the app changes.
  • One key per job. A reporting script needs calls:read and usage:read; a scheduling sync needs appointments:read and appointments:write.
  • Narrow a token further with the scope parameter when you ask for it (Authentication). A token never has a scope its key doesn't.
  • Keys can't be edited. To change scopes, create a new key and revoke the old one.

Account scopes

For keys created in a business's dashboard (direct AssistCall customers; a reseller's clients don't get keys). They reach that one account. Partner keys can hold them too, for the client named in the AssistCall-Account header.

Partner scopes

Only keys created in the partner portal can have these. They work on the partner account itself, so they don't use the AssistCall-Account header. See Partner API.

Endpoints without a scope

Any valid token can call these:

Sandbox credentials

Sandbox credentials (shared on request) hold every :read scope except webhooks:read (webhook URLs can contain their owners' own secrets). Every write is refused with 403 sandbox_read_only, even before scopes are checked.

Try "token", "webhook signature", "rate limit" or "custom domain".