Scopes

Scopes control what your API key can do. Each endpoint names the scope or scopes a key needs.

Available scopes

Open the exact operation in the API reference and read Required scope or Required scopes. Use that list when you create or edit a key; do not infer scope names from the resource name or HTTP method.

For example:

• List accounts needs accounts:read.
• Merge accounts needs both accounts:update and accounts:delete.
• Retrieve a sequence message uses sequences:read; the separate email or message endpoint has its own access rules.

Grant only the operations your integration calls. An admin can change a key’s scopes later without replacing its value.

Sequence message access

sequences:read includes content and references for messages associated with a sequence the caller can access, regardless of the individual email/chat privacy or sender. It does not require emails:read or messages:read. Content is returned only when retrieving one sequence message; lists omit it. Following a reference through the separate email or message endpoint still requires that endpoint’s scopes and access rules.