Scopes

Choose the right permissions for your API key.

Scopes control what an API key can access. Follow the principle of least privilege: request only the scopes your integration needs.

Scope format

Scopes follow the pattern resource:action:

• :read - List and view resources
• :write - Create and update resources
• :delete - Archive or delete resources

:write does not include :delete. If your integration needs to archive contacts, you must request both contacts:write and contacts:delete.

Common use cases

Read-only reporting dashboard

Use the read_only bundle, which includes all :read scopes.

contacts:read, companies:read, deals:read, notes:read,
tags:read, tasks:read, enrichment:read, messages:read,
projects:read, pipeline:read, sequences:read,
relationship:read

CRM sync

Syncing contacts, companies, and deals with an external CRM:

contacts:read, contacts:write
companies:read, companies:write
deals:read, deals:write
notes:read, notes:write
tags:read
relationship:read, relationship:write, relationship:review

Or use the crm bundle.

Enrichment automation

Automatically enrich contacts and check results:

contacts:read
enrichment:read, enrichment:write

Bundles

Bundles are pre-configured groups of scopes for common integrations:

Bundle	Scopes included
full_access	Every scope
read_only	All :read scopes
crm	Companies, deals, contacts, notes, tags, Company relationships (read/write/review)
automation	Sequences, contacts, pipeline, enrichment, tasks

Company relationship scopes

Scope	Access
relationship:read	Company summaries, sourced history, status and attention state, roles, identity links, next actions, and suggestions
relationship:write	Company status/attention updates, contact roles, next actions, and preparation of reviewable suggestions
relationship:review	Human approval or rejection after safeguards and history checkpoint validation
relationship:configure	Admin-only external identity review

Relationship scopes never grant communication delivery. Approval returns data for the existing composer and records approved_not_sent; the normal human composer action remains separate.