Skip to main content
Every Coalesce Quality API token and OAuth client credential is granted a set of scopes. A scope authorises a group of related API methods; a call succeeds when the token carries at least one of the scopes required by that method (OR semantics). Choose the narrowest set of scopes that covers the methods your integration calls. Scopes are selected when you create a token or client in API settings, in the order listed below. There are 53 scopes available to API tokens and OAuth clients. Internal scopes reserved for managed integrations are not listed here.

Edit Issues

SCOPE_ISSUES_EDIT Create and update data quality issues, including changing their status and assignees.

Read Issues

SCOPE_ISSUES_READ View data quality issues and their details.

Edit Incidents

SCOPE_INCIDENTS_EDIT Declare, update, and resolve incidents raised for confirmed issues with business impact.

Read Incidents

SCOPE_INCIDENTS_READ View incidents, including their status and the issues they track.

Edit Entities

SCOPE_ENTITY_EDIT Create and update entities such as tables, dashboards, and jobs in the catalog.

Read Entities

SCOPE_ENTITY_READ View entities such as tables, dashboards, and jobs, along with their metadata.

Edit Entity Types

SCOPE_ENTITY_TYPE_EDIT Define and update custom entity types.

Read Entity Types

SCOPE_ENTITY_TYPE_READ View entity type definitions.

Edit Lineage

SCOPE_LINEAGE_EDIT Create and update lineage relationships between entities.

Read Lineage

SCOPE_LINEAGE_READ View upstream and downstream lineage between entities.

Read Entity Code

SCOPE_CODE_READ View the SQL or source code associated with an entity.

Read Entity Status

SCOPE_STATUS_READ View the health and status of entities, including status summaries and history.

Edit SQL Tests

SCOPE_DATACHECKS_SQLTESTS_EDIT Create, update, and delete SQL tests.

Read SQL Tests

SCOPE_DATACHECKS_SQLTESTS_READ View SQL tests and their configuration.

Read SQL Tests Audit

SCOPE_DATACHECKS_SQLTESTS_AUDIT_READ View the audit history of changes to SQL tests.

Edit Test Suggestions

SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT Accept, dismiss, and manage suggested tests.

Read Test Suggestions

SCOPE_DATACHECKS_TESTSUGGESTIONS_READ View suggested tests.

Trigger Data Checks

SCOPE_DATACHECKS_TRIGGER Trigger data checks to run on demand.

Edit Executions

SCOPE_EXECUTION_EDIT Report execution runs and their results.

Edit Execution Logs

SCOPE_EXECUTION_LOG_EDIT Write logs for execution runs.

Read Executions

SCOPE_EXECUTION_READ View execution run history and results.

Edit Integration Settings

SCOPE_INTEGRATION_EDIT Create, update, and delete integrations and their connection settings.

Read Integration Settings

SCOPE_INTEGRATION_READ View integrations and their connection settings.

Edit Users

SCOPE_USER_EDIT Manage workspace members, including inviting users and updating their roles.

Read Users

SCOPE_USER_READ View workspace members and their roles.

Assign Users

SCOPE_USER_ASSIGN Assign users as owners of entities, issues, and other resources.

Read Monitors

SCOPE_MONITORS_READ View monitors and their configuration.

Edit Automatic Monitors

SCOPE_MONITORS_AUTOMATIC_EDIT Enable, disable, and configure automatic monitors.

Edit Custom Monitors

SCOPE_MONITORS_CUSTOM_EDIT Create, update, and delete custom monitors.

Edit Custom SQL Monitors

SCOPE_MONITORS_CUSTOM_SQL_EDIT Create and update custom monitors backed by a custom SQL query.

Edit Alerts

SCOPE_ALERTS_EDIT Create, update, and delete alert rules and notification channels.

Read Alerts

SCOPE_ALERTS_READ View alert rules and notification channels.

Edit Owners

SCOPE_OWNERS_EDIT Create, update, and delete owners and their notification channels (Slack, email, Microsoft Teams, users).

Read Owners

SCOPE_OWNERS_READ View owners and their notification channels.

Edit Ownership

SCOPE_OWNERSHIP_EDIT Create, update, and delete ownership assignments and the alerts they route to owners.

Read Ownership

SCOPE_OWNERSHIP_READ View ownership assignments and their alert routing.

Edit Data Products

SCOPE_DATAPRODUCT_EDIT Create, update, and delete data products.

Read Data Products

SCOPE_DATAPRODUCT_READ View data products and their contents.

Edit Domains

SCOPE_DOMAIN_EDIT Create, update, and delete domains.

Read Domains

SCOPE_DOMAIN_READ View domains and their contents.

Manage Extensions

SCOPE_EXTENSIONS_MANAGE Manage platform extensions, including data warehouse agent and catalog connections.

MCP Read Access

SCOPE_MCP_READ Use any read-only MCP (Model Context Protocol) tool, including tools added in the future.

MCP Write Access

SCOPE_MCP_WRITE Use any write MCP (Model Context Protocol) tool, including tools added in the future.

Read Reconciliation Audits and Settings

SCOPE_RECON_READ View reconciliation suites, settings, and audit results.

Edit Reconciliation Settings

SCOPE_RECON_EDIT Create and update reconciliation suites and their settings.

Promote Reconciliation Suites to run on Schedule or API

SCOPE_RECON_PROMOTE Promote reconciliation suites so they run on a schedule or via the API.

Edit Check Categorisation Rules

SCOPE_POLICIES_EDIT Create and update rules that categorise data quality checks.

Read Check Categorisation Rules and Status

SCOPE_POLICIES_READ View check categorisation rules and their status.

Read Saved Views

SCOPE_SAVED_VIEW_READ View saved views the caller has access to.

Create and Edit Saved Views

SCOPE_SAVED_VIEW_EDIT Create, update, and delete the caller’s own saved views.

Manage All Saved Views in the Workspace

SCOPE_SAVED_VIEW_ADMIN Manage all saved views in the workspace, including those owned by other users.

Read Folders

SCOPE_FOLDERS_READ Browse the folder hierarchy and list the entities it contains.

Edit Folders

SCOPE_FOLDERS_EDIT Create, update, and delete folders and their placements. No public gRPC/REST methods require this scope directly (e.g. MCP tools or future methods).

Endpoint reference

Every public API method a customer token can call, and the scopes that satisfy it. A token needs any one of the listed scopes.