Skip to content

Scopes and roles

Capability Agent scope owner admin member viewer
Read records, pipelines, activities, metrics, history, export records:read ✓ ✓ ✓ ✓
Create, update, archive records, deals, activities, links records:write ✓ ✓ ✓ –
Hard-delete records and activities records:delete ✓ ✓ – –
Create, edit, delete pipelines and stages pipelines:manage ✓ ✓ – –
Define, edit, delete custom fields fields:manage ✓ ✓ – –
Send feedback feedback:write ✓ ✓ ✓ ✓
Read the audit log audit:read ✓ ✓ ✓ –
Account settings, members, invitations, agents, API keys, billing never ✓ ✓ – –
Change owners’ roles, delete the account never ✓ – – –
  • Default scopes of a new key, and of an OAuth connection that asks for none: records:read records:write feedback:write. records:delete and fields:manage are never default.
  • An OAuth connection always has records:read; at each request its scopes are narrowed to what the connecting person’s current role allows in that account.
  • A missing scope is 403 FORBIDDEN with details.required.
Scope Extra tools listed
records:delete delete_record
audit:read list_audit_events
pipelines:manage create_pipeline, update_pipeline, delete_pipeline, add_stage, update_stage, delete_stage, reorder_stages
fields:manage define_custom_field, update_custom_field, delete_custom_field

The other tools are always listed; their calls still check the scope.