> ## Documentation Index
> Fetch the complete documentation index at: https://docs.synq.io/llms.txt
> Use this file to discover all available pages before exploring further.
# API Scopes
> Scopes that can be granted to Coalesce Quality API tokens and OAuth clients, and the public API methods each one unlocks
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](https://app.synq.io/settings/api), in the order listed below.
There are 43 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.
| Method | Description |
| ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `MarkExpected`
*synq.issues.issues.v1.IssuesService*
`PATCH /api/issues/v1/{issue_id}/mark-expected` | Mark issue as expected. |
| `MarkFixed`
*synq.issues.issues.v1.IssuesService*
`PATCH /api/issues/v1/{issue_id}/mark-fixed` | Mark issue as fixed. |
| `MarkInvestigating`
*synq.issues.issues.v1.IssuesService*
`PATCH /api/issues/v1/{issue_id}/mark-investigating` | Mark issue as being investigated. |
| `MarkNoActionNeeded`
*synq.issues.issues.v1.IssuesService*
`PATCH /api/issues/v1/{issue_id}/mark-no-action-needed` | Mark issue as no action needed. |
| `PostComment`
*synq.issues.issues.v1.IssuesService*
`POST /api/issues/v1/{issue_id}/comment` | Post a comment on an issue. |
| `ClearStatus`
*synq.issues.v2.IssuesService*
`PATCH /api/issues/v2/{issue_id}/clear-status` | Clear the triage status of an issue, returning it to an untriaged state. |
| `MarkExpected`
*synq.issues.v2.IssuesService*
`PATCH /api/issues/v2/{issue_id}/mark-expected` | Mark issue as expected. |
| `MarkFixed`
*synq.issues.v2.IssuesService*
`PATCH /api/issues/v2/{issue_id}/mark-fixed` | Mark issue as fixed. |
| `MarkInvestigating`
*synq.issues.v2.IssuesService*
`PATCH /api/issues/v2/{issue_id}/mark-investigating` | Mark issue as being investigated. |
| `MarkNoActionNeeded`
*synq.issues.v2.IssuesService*
`PATCH /api/issues/v2/{issue_id}/mark-no-action-needed` | Mark issue as no action needed. |
| `PostComment`
*synq.issues.v2.IssuesService*
`POST /api/issues/v2/{issue_id}/comment` | Post a comment on an issue. |
## Read Issues
`SCOPE_ISSUES_READ`
View data quality issues and their details.
| Method | Description |
| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | SubmitFeatureRequest submits a feature request to the Coalesce Quality product team. |
| `BatchGetIssues`
*synq.issues.issues.v1.IssuesService*
`POST /api/issues/v1/by-id` | |
| `ListIssues`
*synq.issues.issues.v1.IssuesService*
`GET /api/issues/v1` | |
| `BatchGetIssues`
*synq.issues.v2.IssuesService*
`POST /api/issues/v2/by-id` | |
| `ListIssues`
*synq.issues.v2.IssuesService*
`GET /api/issues/v2` | |
## Edit Incidents
`SCOPE_INCIDENTS_EDIT`
Declare, update, and resolve incidents raised for confirmed issues with business impact.
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| `AddIssuesToIncident`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/{incident_id}/issues` | |
| `AssignIncidentOwner`
*synq.incidents.v1.IncidentsService*
`PATCH /api/incidents/v1/{incident_id}/assign-owner` | |
| `CancelIncident`
*synq.incidents.v1.IncidentsService*
`PATCH /api/incidents/v1/{incident_id}/cancel` | Cancel an incident |
| `CloseIncident`
*synq.incidents.v1.IncidentsService*
`PATCH /api/incidents/v1/{incident_id}/close` | Close an incident |
| `CreateIncident`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1` | |
| `MergeIncidents`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/{incident_id}/merge` | |
| `PostComment`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/{incident_id}/comment` | Post a comment on an incident. |
| `RemoveIssuesFromIncident`
*synq.incidents.v1.IncidentsService*
`DELETE /api/incidents/v1/{incident_id}/issues` | |
| `RenameIncident`
*synq.incidents.v1.IncidentsService*
`PATCH /api/incidents/v1/{incident_id}/rename` | |
| `SplitIncident`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/{incident_id}/split` | |
| `UpdateIncidentState`
*synq.incidents.v1.IncidentsService*
`PATCH /api/incidents/v1/{incident_id}/state` | |
## Read Incidents
`SCOPE_INCIDENTS_READ`
View incidents, including their status and the issues they track.
| Method | Description |
| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | SubmitFeatureRequest submits a feature request to the Coalesce Quality product team. |
| `BatchGetIncidents`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/by-id` | |
| `ListIncidents`
*synq.incidents.v1.IncidentsService*
`GET /api/incidents/v1` | |
## Edit Entities
`SCOPE_ENTITY_EDIT`
Create and update entities such as tables, dashboards, and jobs in the catalog.
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `DeleteCheckRelationships`
*synq.entities.custom.v1.ChecksRelationshipsService* | |
| `UpsertCheckRelationships`
*synq.entities.custom.v1.ChecksRelationshipsService* | |
| `DeleteEntity`
*synq.entities.custom.v1.EntitiesService*
`DELETE /api/entities/custom/v1/entities` | Delete an entity by its identifier. If the entity does not exist, it will be a no-op. |
| `UpsertEntity`
*synq.entities.custom.v1.EntitiesService*
`POST /api/entities/custom/v1/entities` | Create or update an entity. If the entity does not exist, it will be created, otherwise it will be u... |
| `DeleteEntityFeature`
*synq.entities.custom.v1.FeaturesService*
`DELETE /api/entities/custom/v1/features` | Delete an entity by its identifier. If the entity does not exist, it will be a no-op. |
| `UpsertEntityFeature`
*synq.entities.custom.v1.FeaturesService*
`POST /api/entities/custom/v1/features` | Create or update an entity. If the entity does not exist, it will be created, otherwise it will be u... |
| `DeleteEntitiesGroup`
*synq.entities.custom.v1.GroupsService*
`DELETE /api/entities/custom/v1/groups` | DeleteEntitiesGroup deletes a group by its identifier. If the group does not exist, it will be a no-... |
| `UpsertEntitiesGroup`
*synq.entities.custom.v1.GroupsService*
`POST /api/entities/custom/v1/groups` | UpsertEntitiesGroup updates current definition of group to the server. As part of the upsert operati... |
## Read Entities
`SCOPE_ENTITY_READ`
View entities such as tables, dashboards, and jobs, along with their metadata.
| Method | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `GenerateConnectionsYaml`
*synq.agent.dwh.v1.ConnectionsService* | GenerateConnectionsYaml converts data warehouse connections to YAML configuration format. |
| `ListConnections`
*synq.agent.dwh.v1.ConnectionsService* | ListConnections retrieves data warehouse connections for a workspace. |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | SubmitFeatureRequest submits a feature request to the Coalesce Quality product team. |
| `ListAnnotations`
*synq.entities.annotations.v1.AnnotationsService*
`GET /api/entities/annotations/v1` | List all available annotations with their usage counts across entities. |
| `BatchChange`
*synq.entities.changes.v1.ChangesService*
`POST /api/changes/v1/by-id` | BatchChange retrieves multiple entity changes by their IDs in a single request. |
| `List`
*synq.entities.changes.v1.ChangesService*
`GET /api/changes/v1` | Retrieves the complete change history for specified entities. |
| `GetCoverage`
*synq.entities.checks.v1.ChecksCoverageService* | GetCoverage retrieves the coverage of checks for a specific entity. |
| `GetTableConstraints`
*synq.entities.constraints.v1.TableConstraintsService*
`GET /api/constraints/v1/table-constraints` | Get table constraints (primary keys, foreign keys, indexes, etc.) for a given entity. |
| `BatchDatabaseCoordinates`
*synq.entities.coordinates.v1.DatabaseCoordinatesService*
`POST /api/coordinates/v1/database/by-id` | Get multiple DatabaseCoordinates for identifiers. |
| `BatchIdsByCoordinates`
*synq.entities.coordinates.v1.DatabaseCoordinatesService*
`POST /api/coordinates/v1/database/by-fqn` | Given database FQN return possible entity ids. |
| `ListEntities`
*synq.entities.custom.v1.EntitiesService*
`GET /api/entities/custom/v1/entities` | List all entities. |
| `ListEntityFeatures`
*synq.entities.custom.v1.FeaturesService*
`POST /api/entities/custom/v1/features/list` | List all entities. |
| `ListEntityGroups`
*synq.entities.custom.v1.GroupsService*
`POST /api/entities/custom/v1/groups/list` | ListEntityGroups lists all groups. |
| `ListTypes`
*synq.entities.custom.v1.TypesService*
`POST /api/entities/custom/v1/types/list` | List all entities. |
| `BatchGetEntities`
*synq.entities.entities.v1.EntitiesService*
`POST /api/entities/v1/by-id` | Get multiple entities by their identifiers. |
| `GetEntity`
*synq.entities.entities.v1.EntitiesService* | Get specific entity by its identifier. |
| `ListEntities`
*synq.entities.entities.v1.EntitiesService*
`GET /api/entities/v1` | List entities matching the given filter |
| `SearchEntities`
*synq.entities.entities.v1.EntitiesService*
`GET /api/entities/v1/search` | Search for entities. |
| `GetImpact`
*synq.entities.impact.v1.ImpactService*
`POST /api/impact/v1` | |
| `BatchResolveIdentifiers`
*synq.entities.resolve.v1.IdentifierResolveService*
`POST /api/resolve/v1/by-id` | Resolve multiple identifiers, returning their Coalesce Quality paths and identity groups. |
| `BatchSchemaMismatches`
*synq.entities.schemas.v1.SchemaMismatchesService*
`POST /api/schema-mismatches/v1` | Get schema mismatches for a batch of entities by their identifiers. |
| `GetSchema`
*synq.entities.schemas.v1.SchemasService*
`GET /api/schema/v1` | Get schema of the entity its identifier. |
| `BatchSqlDetails`
*synq.entities.sql\_insights.v1.SqlInsightsService*
`POST /api/sql-insights/v1/details:batch` | BatchSqlDetails returns the SQL details (currently the set of detected SQL |
| `ListSqlConstructs`
*synq.entities.sql\_insights.v1.SqlInsightsService*
`GET /api/sql-insights/v1/constructs` | ListSqlConstructs returns the distribution of SQL constructs across all |
| `GetDiffByCommit`
*synq.git.commits.v1.CommitsService*
`GET /api/git/v1/commit/{commit_sha}` | |
| `GenerateQuery`
*synq.queries.v1.NLQueryService*
`POST /api/queries/v1/generate` | GenerateQuery generates a Query from a natural language description. |
## Edit Entity Types
`SCOPE_ENTITY_TYPE_EDIT`
Define and update custom entity types.
| Method | Description |
| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `DeleteType`
*synq.entities.custom.v1.TypesService*
`DELETE /api/entities/custom/v1/types` | Delete an entity by its identifier. If the entity does not exist, it will be a no-op. |
| `UpsertType`
*synq.entities.custom.v1.TypesService*
`POST /api/entities/custom/v1/types` | Create or update an entity. If the entity does not exist, it will be created, otherwise it will be u... |
## Read Entity Types
`SCOPE_ENTITY_TYPE_READ`
View entity type definitions.
| Method | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------ |
| `ListTypes`
*synq.entities.custom.v1.TypesService*
`POST /api/entities/custom/v1/types/list` | List all entities. |
## Edit Lineage
`SCOPE_LINEAGE_EDIT`
Create and update lineage relationships between entities.
| Method | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `DeleteRelationships`
*synq.entities.custom.v1.RelationshipsService*
`DELETE /api/entities/custom/v1/relationships` | Delete relationships between entities. If the relationship does not exist, it will be ignored. |
| `UpsertRelationships`
*synq.entities.custom.v1.RelationshipsService*
`POST /api/entities/custom/v1/relationships` | Create or update relationships between entities. If the relationship already exists, it will be upda... |
## Read Lineage
`SCOPE_LINEAGE_READ`
View upstream and downstream lineage between entities.
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | SubmitFeatureRequest submits a feature request to the Coalesce Quality product team. |
| `ListRelationships`
*synq.entities.custom.v1.RelationshipsService*
`POST /api/entities/custom/v1/relationships/list` | Delete relationships between entities. If the relationship does not exist, it will be ignored. |
| `GetImpact`
*synq.entities.impact.v1.ImpactService*
`POST /api/impact/v1` | |
| `GetLineage`
*synq.entities.lineage.v1.LineageService*
`POST /api/lineage/v1` | |
| `BatchOrchestration`
*synq.entities.orchestration.v1.OrchestrationService*
`GET /api/orchestration/v1` | BatchOrchestration retrieves orchestration relationships for multiple entities. |
## Read Entity Code
`SCOPE_CODE_READ`
View the SQL or source code associated with an entity.
| Method | Description |
| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | SubmitFeatureRequest submits a feature request to the Coalesce Quality product team. |
| `ListCode`
*synq.entities.code.v1.CodeService*
`GET /api/code/v1` | ListCode retrieves all code artifacts associated with a specific entity. |
| `GetDiffByChangeId`
*synq.git.commits.v1.CommitsService*
`GET /api/git/v1/change/{change_id}` | |
## Read Entity Status
`SCOPE_STATUS_READ`
View the health and status of entities, including status summaries and history.
| Method | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `BatchGetIncidents`
*synq.entities.status.v1.EntityIncidentsService*
`POST /api/status/v1/incidents/by-id` | Get multiple entity statuses by their identifiers. |
| `GetIncidents`
*synq.entities.status.v1.EntityIncidentsService* | Get specific entity status by its identifier. |
| `BatchGetIssuesStatus`
*synq.entities.status.v1.EntityIssuesService*
`POST /api/status/v1/issues/by-id` | Get multiple entity statuses by their identifiers. |
| `GetIssuesStatus`
*synq.entities.status.v1.EntityIssuesService* | Get specific entity status by its identifier. |
## Edit SQL Tests
`SCOPE_DATACHECKS_SQLTESTS_EDIT`
Create, update, and delete SQL tests.
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------- |
| `BatchDeleteSqlTests`
*synq.datachecks.sqltests.v1.SqlTestsService*
`DELETE /api/datachecks/sqltests/v1` | Delete SqlTests by their IDs. |
| `BatchUpsertSqlTests`
*synq.datachecks.sqltests.v1.SqlTestsService*
`POST /api/datachecks/sqltests/v1` | Upsert SqlTests based on a unique ID. |
## Read SQL Tests
`SCOPE_DATACHECKS_SQLTESTS_READ`
View SQL tests and their configuration.
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | SubmitFeatureRequest submits a feature request to the Coalesce Quality product team. |
| `BatchGetSqlTests`
*synq.datachecks.sqltests.v1.SqlTestsService*
`POST /api/datachecks/sqltests/v1/by-id` | Get SqlTests by their IDs. |
| `ListSqlTests`
*synq.datachecks.sqltests.v1.SqlTestsService*
`GET /api/datachecks/sqltests/v1` | List SqlTests for given annotations. |
## Read SQL Tests Audit
`SCOPE_DATACHECKS_SQLTESTS_AUDIT_READ`
View the audit history of changes to SQL tests.
| Method | Description |
| -------------------------------------------------------------------- | --------------------------------------------------------- |
| `GetSqlTestAudit`
*synq.datachecks.sqltests.v1.SqlTestsService* | Get SqlTest audit from a given execution ID in jwt token. |
## Edit Test Suggestions
`SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT`
Accept, dismiss, and manage suggested tests.
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
| `MarkAsCancelled`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `MarkAsCompleted`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `MarkAsFailed`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `MarkAsRunning`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `SuggestFor`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `BatchAcceptTestSuggestions`
*synq.datachecks.testsuggestions.v1.TestSuggestionsService*
`PATCH /api/datachecks/testsuggestions/v1/accepted` | |
| `BatchCreateTestSuggestions`
*synq.datachecks.testsuggestions.v1.TestSuggestionsService*
`POST /api/datachecks/testsuggestions/v1` | |
| `BatchRejectTestSuggestions`
*synq.datachecks.testsuggestions.v1.TestSuggestionsService*
`PATCH /api/datachecks/testsuggestions/v1/rejected` | |
## Read Test Suggestions
`SCOPE_DATACHECKS_TESTSUGGESTIONS_READ`
View suggested tests.
| Method | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | SubmitFeatureRequest submits a feature request to the Coalesce Quality product team. |
| `BatchSuggestionStates`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `GetActiveSuggestionStatesFor`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `ListSuggestionStates`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `BatchGetTestSuggestionsForEntities`
*synq.datachecks.testsuggestions.v1.TestSuggestionsService*
`GET /api/datachecks/testsuggestions/v1` | |
## Trigger Data Checks
`SCOPE_DATACHECKS_TRIGGER`
Trigger data checks to run on demand.
| Method | Description |
| ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `TriggerDatachecks`
*synq.datachecks.v1.TriggerService*
`POST /api/datachecks/scheduler/v1/trigger` | TriggerDatachecks executes datachecks for the specified entities. |
## Edit Executions
`SCOPE_EXECUTION_EDIT`
Report execution runs and their results.
| Method | Description |
| -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `UpsertExecution`
*synq.entities.custom.v1.EntityExecutionsService*
`POST /api/entities/custom/executions/v1` | Execution affects status of the custom entity |
| `UpsertLogEntry`
*synq.entities.custom.v1.EntityExecutionsService*
`POST /api/entities/custom/executions/v1/log-entry` | LogEntry is a log message for the custom entity |
| `UpsertExecution`
*synq.entities.executions.v1.EntityExecutionsService*
`POST /api/executions/v1` | Execution affects status of the custom entity |
| `UpsertLogEntry`
*synq.entities.executions.v1.EntityExecutionsService*
`POST /api/executions/v1/log-entry` | LogEntry is a log message for the custom entity |
## Edit Execution Logs
`SCOPE_EXECUTION_LOG_EDIT`
Write logs for execution runs.
| Method | Description |
| -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `UpsertLogEntry`
*synq.entities.custom.v1.EntityExecutionsService*
`POST /api/entities/custom/executions/v1/log-entry` | LogEntry is a log message for the custom entity |
| `UpsertLogEntry`
*synq.entities.executions.v1.EntityExecutionsService*
`POST /api/executions/v1/log-entry` | LogEntry is a log message for the custom entity |
## Read Executions
`SCOPE_EXECUTION_READ`
View execution run history and results.
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | SubmitFeatureRequest submits a feature request to the Coalesce Quality product team. |
| `BatchGetExecutions`
*synq.entities.executions.v2.EntityExecutionsService*
`POST /api/executions/v2/by-id` | BatchGetExecutions retrieves multiple executions by their IDs. |
| `GetExecutionsSummary`
*synq.entities.executions.v2.EntityExecutionsService*
`POST /api/executions/v2/summary` | GetExecutionsSummary provides aggregated statistics about executions for specified entities. |
| `GetLatestExecutions`
*synq.entities.executions.v2.EntityExecutionsService*
`POST /api/executions/v2/latest` | GetLatestExecutions retrieves the most recent execution for each specified entity. |
| `ListExecutions`
*synq.entities.executions.v2.EntityExecutionsService*
`GET /api/executions/v2/list` | ListExecutions retrieves a paginated list of executions for one or more entities. |
## Edit Integration Settings
`SCOPE_INTEGRATION_EDIT`
Create, update, and delete integrations and their connection settings.
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- |
| `AcceptPromptSuggestion`
*synq.agent.sre.v1.SreAgentService* | AcceptPromptSuggestion applies a pending suggestion to the matching SRE agent |
| `DismissPromptSuggestion`
*synq.agent.sre.v1.SreAgentService* | DismissPromptSuggestion marks a pending suggestion as dismissed with an optional |
| `RecordPromptSuggestion`
*synq.agent.sre.v1.SreAgentService* | RecordPromptSuggestion is the producer-side endpoint used by the offline |
| `BatchGetIntegrations`
*synq.integrations.v1.IntegrationsService*
`POST /api/integrations/v1/by-id` | Fetch multiple integrations by id in one call. Ids not found (or not in the |
| `CreateIntegration`
*synq.integrations.v1.IntegrationsService*
`POST /api/integrations/v1` | Create a new integration. The server assigns the id and returns the created |
| `DeleteIntegration`
*synq.integrations.v1.IntegrationsService*
`DELETE /api/integrations/v1/{integration_id}` | Delete an integration. The integration stops being scheduled and is removed |
| `DisableIntegration`
*synq.integrations.v1.IntegrationsService*
`POST /api/integrations/v1/{integration_id}/disable` | Disable an integration without deleting it. The configuration is kept but |
| `EnableIntegration`
*synq.integrations.v1.IntegrationsService*
`POST /api/integrations/v1/{integration_id}/enable` | Enable a previously disabled integration. No-op if already enabled. |
| `GetIntegration`
*synq.integrations.v1.IntegrationsService* | Fetch a single integration by id. Secret config fields are masked. |
| `GetIntegrationHealth`
*synq.integrations.v1.IntegrationsService* | Return current health plus a paginated history of recent runs for an |
| `ListIntegrations`
*synq.integrations.v1.IntegrationsService*
`GET /api/integrations/v1` | List all integrations in the workspace (optionally filtered by enabled |
| `RefreshIntegration`
*synq.integrations.v1.IntegrationsService*
`POST /api/integrations/v1/{integration_id}/refresh` | Trigger an immediate, ad-hoc refresh of an integration. Available only for |
| `UpdateIntegration`
*synq.integrations.v1.IntegrationsService*
`PUT /api/integrations/v1/{integration_id}` | Update an integration. The `config` is replaced wholesale — send the |
| `SetPlatformAuthentication`
*synq.platforms.v1.PlatformsService*
`POST /api/platforms/v1` | |
## Edit Users
`SCOPE_USER_EDIT`
Manage workspace members, including inviting users and updating their roles.
| Method | Description |
| ----------------------------------------------------- | ----------- |
| `DeleteUserAliases`
*synq.users.v1.UsersService* | |
| `UpsertUserAliases`
*synq.users.v1.UsersService* | |
## Read Users
`SCOPE_USER_READ`
View workspace members and their roles.
| Method | Description |
| -------------------------------------------------------------------------- | -------------------------------------------------- |
| `ListDomainMembers`
*synq.domains.members.v1.DomainMembersService* | List domain members. |
| `ListUserDomains`
*synq.domains.members.v1.DomainMembersService* | List domains for the given user. |
| `SetDefaultUserDomain`
*synq.domains.members.v1.DomainMembersService* | Set default domain for user. |
| `BatchGetUsers`
*synq.users.v1.UsersService* | |
| `GetByAlias`
*synq.users.v1.UsersService* | |
| `GetByEmail`
*synq.users.v1.UsersService* | |
| `GetUserAliases`
*synq.users.v1.UsersService* | |
| `GetUserIdentities`
*synq.users.v1.UsersService* | Returns all canonical identity strings for a user. |
| `ListUsers`
*synq.users.v1.UsersService* | |
## Assign Users
`SCOPE_USER_ASSIGN`
Assign users as owners of entities, issues, and other resources.
| Method | Description |
| ------------------------------------------------------------------------- | ---------------------- |
| `AddDomainMembers`
*synq.domains.members.v1.DomainMembersService* | Add domain members. |
| `RemoveDomainMembers`
*synq.domains.members.v1.DomainMembersService* | Remove domain members. |
## Read Monitors
`SCOPE_MONITORS_READ`
View monitors and their configuration.
| Method | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | SubmitFeatureRequest submits a feature request to the Coalesce Quality product team. |
| `ListConfigsMonitors`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`GET /api/monitors/custom-monitors/v1/by-config` | |
| `ListMonitors`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`GET /api/monitors/custom-monitors/v1` | |
| `History`
*synq.monitors.history.v1.HistoryService*
`GET /api/monitors/history/v1/{monitor_path}` | |
| `MonitorInfo`
*synq.monitors.info.v1.MonitorInfoService*
`GET /api/monitors/info/v1` | |
| `BatchGetLatestEntityMetrics`
*synq.monitors.predictions.v1.MonitorPredictionsService*
`POST /api/monitors/predictions/v1/entity-metrics:batchLatest` | Returns the most recent observed table-stats sample (row count, freshness) for each |
| `GetEntityMetrics`
*synq.monitors.predictions.v1.MonitorPredictionsService*
`GET /api/monitors/predictions/v1/entity-metrics` | Returns raw metric timeseries for an entity. Identity-aware: resolves |
| `GetMonitorPredictions`
*synq.monitors.predictions.v1.MonitorPredictionsService*
`GET /api/monitors/predictions/v1` | Returns prediction timeseries for a monitor. The monitor must exist |
## Edit Automatic Monitors
`SCOPE_MONITORS_AUTOMATIC_EDIT`
Enable, disable, and configure automatic monitors.
| Method | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `BatchDeleteDeploymentRules`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`DELETE /api/monitors/automated/v1/deployment-rules/batch` | |
| `BatchDeployDeploymentRules`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`POST /api/monitors/automated/v1/deployment-rules/batch/deployed` | |
| `BatchGetDeploymentRules`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`GET /api/monitors/automated/v1/deployment-rules/batch` | |
| `BatchUpdateDeploymentRuleTitle`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`PATCH /api/monitors/automated/v1/deployment-rules` | |
| `BatchUpsertDeploymentRules`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`POST /api/monitors/automated/v1/deployment-rules/batch` | |
| `DeleteDeploymentRule`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`DELETE /api/monitors/automated/v1/deployment-rule/{id}` | |
| `DeployDeploymentRule`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`POST /api/monitors/automated/v1/deployment-rules/deployed` | |
| `GetDeployDeleteOverview`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`GET /api/monitors/automated/v1/deployment-rule/{id}/deleted` | |
| `GetDeployOverview`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`GET /api/monitors/automated/v1/deployment-rule` | |
| `ListDeploymentRules`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`GET /api/monitors/automated/v1/deployment-rules` | |
| `ListDeploymentRulesForAsset`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`GET /api/monitors/automated/v1/deployment-rules/{asset_path}` | |
| `UpsertDeploymentRule`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`POST /api/monitors/automated/v1/deployment-rules` | |
## Edit Custom Monitors
`SCOPE_MONITORS_CUSTOM_EDIT`
Create, update, and delete custom monitors.
| Method | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `BatchCreateMonitor`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1` | |
| `BatchDeleteMonitor`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1/delete` | |
| `BatchUpdateMonitor`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`PUT /api/monitors/custom-monitors/v1` | |
| `BatchUpdateMonitorMode`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1/mode` | |
| `BatchUpdateMonitorSeverity`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1/severity` | |
| `ConfigChangesOverview`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1/config-changes` | |
## Edit Custom SQL Monitors
`SCOPE_MONITORS_CUSTOM_SQL_EDIT`
Create and update custom monitors backed by a custom SQL query.
| Method | Description |
| -------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `BatchCreateMonitor`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1` | |
| `BatchUpdateMonitor`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`PUT /api/monitors/custom-monitors/v1` | |
## Edit Alerts
`SCOPE_ALERTS_EDIT`
Create, update, and delete alert rules and notification channels.
| Method | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| `Create`
*synq.alerts.services.v1.AlertsService*
`POST /api/alerts/v1` | Create a new alert configuration. |
| `Delete`
*synq.alerts.services.v1.AlertsService*
`DELETE /api/alerts/v1` | Delete an existing alert configuration. |
| `ToggleEnabled`
*synq.alerts.services.v1.AlertsService*
`POST /api/alerts/v1/toggle` | Enables or disables an existing alert configuration. |
| `Update`
*synq.alerts.services.v1.AlertsService*
`PUT /api/alerts/v1` | Update an existing alert configuration. |
## Read Alerts
`SCOPE_ALERTS_READ`
View alert rules and notification channels.
| Method | Description |
| -------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `BatchGet`
*synq.alerts.services.v1.AlertsService*
`POST /api/alerts/v1/get` | Get multiple alert configurations by their identifiers. |
| `List`
*synq.alerts.services.v1.AlertsService*
`POST /api/alerts/v1/list` | Retrieves a list of alert configurations based on filters. |
## Edit Data Products
`SCOPE_DATAPRODUCT_EDIT`
Create, update, and delete data products.
| Method | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- |
| `Delete`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/delete` | Delete a dataproduct by its identifier. |
| `RemoveDefinitionPart`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/definition/part/delete` | Remove definition part from the definition of an existing dataproduct. |
| `SetDefinition`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/definition` | Set the definition for an existing dataproduct. |
| `Upsert`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1` | Create or update a dataproduct. |
| `UpsertDefinitionPart`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/definition/part` | Upsert definition part to the definition of an existing dataproduct. |
## Read Data Products
`SCOPE_DATAPRODUCT_READ`
View data products and their contents.
| Method | Description |
| ------------------------------------------------------------------------------------------ | ----------------------------------------------- |
| `Get`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/get` | Get multiple dataproducts by their identifiers. |
| `List`
*synq.dataproducts.v1.DataproductsService*
`GET /api/dataproducts/v1` | List all the dataproducts in the current scope. |
## Edit Domains
`SCOPE_DOMAIN_EDIT`
Create, update, and delete domains.
| Method | Description |
| ------------------------------------------------------------ | ----------------------------------------------------------------- |
| `Delete`
*synq.domains.v1.DomainsService* | Delete a domain by its identifier. |
| `RemoveDefinitionPart`
*synq.domains.v1.DomainsService* | Remove definition part from the definition of an existing domain. |
| `SetDefinition`
*synq.domains.v1.DomainsService* | Set the definition for an existing domain. |
| `Upsert`
*synq.domains.v1.DomainsService* | Create or update a domain. |
| `UpsertDefinitionPart`
*synq.domains.v1.DomainsService* | Upsert definition part to the definition of an existing domain. |
## Read Domains
`SCOPE_DOMAIN_READ`
View domains and their contents.
| Method | Description |
| ----------------------------------------------------------------- | ---------------------------------------------- |
| `BatchGet`
*synq.domains.v1.DomainsService* | Get multiple domains by their identifiers. |
| `FetchDomainWithSubDomains`
*synq.domains.v1.DomainsService* | Get a domain with its sub-domains |
| `List`
*synq.domains.v1.DomainsService* | List all the domains in the current workspace. |
## Manage Extensions
`SCOPE_EXTENSIONS_MANAGE`
Manage platform extensions, including data warehouse agent and catalog connections.
| Method | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `GenerateConnectionsYaml`
*synq.agent.dwh.v1.ConnectionsService* | GenerateConnectionsYaml converts data warehouse connections to YAML configuration format. |
| `ListConnections`
*synq.agent.dwh.v1.ConnectionsService* | ListConnections retrieves data warehouse connections for a workspace. |
| `Activate`
*synq.extensions.atlan.integrations.v1.AtlanIntegrationService*
`PATCH /api/extensions/atlan/integrations/v1` | Activate or deactivate the integration. |
| `Ping`
*synq.extensions.atlan.integrations.v1.AtlanIntegrationService*
`POST /api/extensions/atlan/integrations/v1/ping` | Pings Atlan with the given connection credentials. |
| `Remove`
*synq.extensions.atlan.integrations.v1.AtlanIntegrationService*
`DELETE /api/extensions/atlan/integrations/v1` | |
| `Upsert`
*synq.extensions.atlan.integrations.v1.AtlanIntegrationService*
`POST /api/extensions/atlan/integrations/v1` | Upserts an integration and validates it by checking if the provided API URL and token are valid. |
| `GetAtlanConnections`
*synq.extensions.atlan.provider.v1.AtlanProviderService*
`GET /api/extensions/atlan/provider/v1/connections` | |
| `GetAtlanDataProducts`
*synq.extensions.atlan.provider.v1.AtlanProviderService*
`GET /api/extensions/atlan/provider/v1/data-products` | |
| `GetAtlanDomains`
*synq.extensions.atlan.provider.v1.AtlanProviderService*
`GET /api/extensions/atlan/provider/v1/domains` | |
| `FetchRuns`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`GET /api/extensions/atlan/workflows/v1/runs` | |
| `GetConnectionMappings`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`GET /api/extensions/atlan/workflows/v1/connection-mappings` | |
| `GetDomainMappings`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`GET /api/extensions/atlan/workflows/v1/domain-mappings` | |
| `GetMappingToggles`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`GET /api/extensions/atlan/workflows/v1/mappings/toggle` | |
| `GetProductMappings`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`GET /api/extensions/atlan/workflows/v1/product-mappings` | |
| `RemoveConnectionMappings`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`DELETE /api/extensions/atlan/workflows/v1/connection-mappings` | |
| `SetConnectionMappings`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`POST /api/extensions/atlan/workflows/v1/connection-mappings` | |
| `SetMappingToggles`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`POST /api/extensions/atlan/workflows/v1/mappings/toggle` | |
| `Synchronize`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`POST /api/extensions/atlan/workflows/v1/synchronize` | Run a synchronization job for the integration. |
## MCP Read Access
`SCOPE_MCP_READ`
Use any read-only MCP (Model Context Protocol) tool, including tools added in the future.
| Method | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `GenerateConnectionsYaml`
*synq.agent.dwh.v1.ConnectionsService* | GenerateConnectionsYaml converts data warehouse connections to YAML configuration format. |
| `ListConnections`
*synq.agent.dwh.v1.ConnectionsService* | ListConnections retrieves data warehouse connections for a workspace. |
| `GetAuditLog`
*synq.agent.recon.v1.AuditLogService* | GetAuditLog returns a single audit log by invocation ID. |
| `ListAuditLogs`
*synq.agent.recon.v1.AuditLogService* | ListAuditLogs returns audit logs ordered from newest to oldest, optionally filtered by suite and tim... |
| `BatchReconciliationRunState`
*synq.agent.recon.v1.RunStateService* | BatchReconciliationRunState returns the latest concluded run and any ongoing |
| `ListReconciliationRunState`
*synq.agent.recon.v1.RunStateService* | ListReconciliationRunState returns runs filtered by status and/or suite\_id. |
| `GetSuiteConfig`
*synq.agent.recon.v1.SuiteConfigService* | Get the latest version of a suite config by suite\_id. |
| `GetSuiteConfigVersion`
*synq.agent.recon.v1.SuiteConfigService* | Get a specific historical version of a suite config. |
| `ListSuiteConfigVersions`
*synq.agent.recon.v1.SuiteConfigService* | Get version history for a suite config. |
| `ListSuiteConfigs`
*synq.agent.recon.v1.SuiteConfigService* | List latest suite configs with filtering and pagination. |
| `GetSuiteDeployment`
*synq.agent.recon.v1.SuiteDeploymentService* | Fetch a deployment by suite\_id or deployment\_id. |
| `ListSuiteDeploymentHistory`
*synq.agent.recon.v1.SuiteDeploymentService* | List the append-only history of a deployment (every promote, |
| `ListSuiteDeployments`
*synq.agent.recon.v1.SuiteDeploymentService* | List deployments for the caller's workspace. Filters support answering |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | SubmitFeatureRequest submits a feature request to the Coalesce Quality product team. |
| `GetConfig`
*synq.agent.sre.v1.SreAgentService* | GetConfig returns the Scout configuration (system prompts + DWH connection |
| `ListPromptSuggestions`
*synq.agent.sre.v1.SreAgentService* | ListPromptSuggestions returns prompt-improvement suggestions recorded for the |
| `BatchSuggestionStates`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `GetActiveSuggestionStatesFor`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `ListSuggestionStates`
*synq.agent.sre.v1.TestsSuggestionStateService* | |
| `BatchLatestConclusions`
*synq.agent.sre.v1.TriageService*
`GET /api/triage/v1/conclusions` | Retrieves the latest triage state for one or more issues. This method is used by the LLM agent |
| `BatchTriageState`
*synq.agent.sre.v1.TriageService*
`GET /api/triage/v1/states` | Retrieves the triage state for one or more issues. This method is used by the LLM agent |
| `ListTriageState`
*synq.agent.sre.v1.TriageService*
`GET /api/triage/v1/statuses` | Retrieves the triage state for one or more issues. This method is used by the LLM agent |
| `BatchGetSqlTests`
*synq.datachecks.sqltests.v1.SqlTestsService*
`POST /api/datachecks/sqltests/v1/by-id` | Get SqlTests by their IDs. |
| `ListSqlTests`
*synq.datachecks.sqltests.v1.SqlTestsService*
`GET /api/datachecks/sqltests/v1` | List SqlTests for given annotations. |
| `BatchGetTestSuggestionsForEntities`
*synq.datachecks.testsuggestions.v1.TestSuggestionsService*
`GET /api/datachecks/testsuggestions/v1` | |
| `Get`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/get` | Get multiple dataproducts by their identifiers. |
| `List`
*synq.dataproducts.v1.DataproductsService*
`GET /api/dataproducts/v1` | List all the dataproducts in the current scope. |
| `ListAnnotations`
*synq.entities.annotations.v1.AnnotationsService*
`GET /api/entities/annotations/v1` | List all available annotations with their usage counts across entities. |
| `BatchChange`
*synq.entities.changes.v1.ChangesService*
`POST /api/changes/v1/by-id` | BatchChange retrieves multiple entity changes by their IDs in a single request. |
| `List`
*synq.entities.changes.v1.ChangesService*
`GET /api/changes/v1` | Retrieves the complete change history for specified entities. |
| `GetCoverage`
*synq.entities.checks.v1.ChecksCoverageService* | GetCoverage retrieves the coverage of checks for a specific entity. |
| `ListCode`
*synq.entities.code.v1.CodeService*
`GET /api/code/v1` | ListCode retrieves all code artifacts associated with a specific entity. |
| `GetTableConstraints`
*synq.entities.constraints.v1.TableConstraintsService*
`GET /api/constraints/v1/table-constraints` | Get table constraints (primary keys, foreign keys, indexes, etc.) for a given entity. |
| `BatchDatabaseCoordinates`
*synq.entities.coordinates.v1.DatabaseCoordinatesService*
`POST /api/coordinates/v1/database/by-id` | Get multiple DatabaseCoordinates for identifiers. |
| `BatchIdsByCoordinates`
*synq.entities.coordinates.v1.DatabaseCoordinatesService*
`POST /api/coordinates/v1/database/by-fqn` | Given database FQN return possible entity ids. |
| `ListEntities`
*synq.entities.custom.v1.EntitiesService*
`GET /api/entities/custom/v1/entities` | List all entities. |
| `ListEntityFeatures`
*synq.entities.custom.v1.FeaturesService*
`POST /api/entities/custom/v1/features/list` | List all entities. |
| `ListEntityGroups`
*synq.entities.custom.v1.GroupsService*
`POST /api/entities/custom/v1/groups/list` | ListEntityGroups lists all groups. |
| `ListRelationships`
*synq.entities.custom.v1.RelationshipsService*
`POST /api/entities/custom/v1/relationships/list` | Delete relationships between entities. If the relationship does not exist, it will be ignored. |
| `BatchGetEntities`
*synq.entities.entities.v1.EntitiesService*
`POST /api/entities/v1/by-id` | Get multiple entities by their identifiers. |
| `GetEntity`
*synq.entities.entities.v1.EntitiesService* | Get specific entity by its identifier. |
| `ListEntities`
*synq.entities.entities.v1.EntitiesService*
`GET /api/entities/v1` | List entities matching the given filter |
| `SearchEntities`
*synq.entities.entities.v1.EntitiesService*
`GET /api/entities/v1/search` | Search for entities. |
| `BatchGetExecutions`
*synq.entities.executions.v2.EntityExecutionsService*
`POST /api/executions/v2/by-id` | BatchGetExecutions retrieves multiple executions by their IDs. |
| `GetExecutionsSummary`
*synq.entities.executions.v2.EntityExecutionsService*
`POST /api/executions/v2/summary` | GetExecutionsSummary provides aggregated statistics about executions for specified entities. |
| `GetLatestExecutions`
*synq.entities.executions.v2.EntityExecutionsService*
`POST /api/executions/v2/latest` | GetLatestExecutions retrieves the most recent execution for each specified entity. |
| `ListExecutions`
*synq.entities.executions.v2.EntityExecutionsService*
`GET /api/executions/v2/list` | ListExecutions retrieves a paginated list of executions for one or more entities. |
| `GetImpact`
*synq.entities.impact.v1.ImpactService*
`POST /api/impact/v1` | |
| `GetLineage`
*synq.entities.lineage.v1.LineageService*
`POST /api/lineage/v1` | |
| `BatchOrchestration`
*synq.entities.orchestration.v1.OrchestrationService*
`GET /api/orchestration/v1` | BatchOrchestration retrieves orchestration relationships for multiple entities. |
| `BatchResolveIdentifiers`
*synq.entities.resolve.v1.IdentifierResolveService*
`POST /api/resolve/v1/by-id` | Resolve multiple identifiers, returning their Coalesce Quality paths and identity groups. |
| `BatchSchemaMismatches`
*synq.entities.schemas.v1.SchemaMismatchesService*
`POST /api/schema-mismatches/v1` | Get schema mismatches for a batch of entities by their identifiers. |
| `GetSchema`
*synq.entities.schemas.v1.SchemasService*
`GET /api/schema/v1` | Get schema of the entity its identifier. |
| `BatchSqlDetails`
*synq.entities.sql\_insights.v1.SqlInsightsService*
`POST /api/sql-insights/v1/details:batch` | BatchSqlDetails returns the SQL details (currently the set of detected SQL |
| `ListSqlConstructs`
*synq.entities.sql\_insights.v1.SqlInsightsService*
`GET /api/sql-insights/v1/constructs` | ListSqlConstructs returns the distribution of SQL constructs across all |
| `BatchGetIncidents`
*synq.entities.status.v1.EntityIncidentsService*
`POST /api/status/v1/incidents/by-id` | Get multiple entity statuses by their identifiers. |
| `GetIncidents`
*synq.entities.status.v1.EntityIncidentsService* | Get specific entity status by its identifier. |
| `BatchGetIssuesStatus`
*synq.entities.status.v1.EntityIssuesService*
`POST /api/status/v1/issues/by-id` | Get multiple entity statuses by their identifiers. |
| `GetDiffByChangeId`
*synq.git.commits.v1.CommitsService*
`GET /api/git/v1/change/{change_id}` | |
| `GetDiffByCommit`
*synq.git.commits.v1.CommitsService*
`GET /api/git/v1/commit/{commit_sha}` | |
| `BatchGetIncidents`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/by-id` | |
| `ListIncidents`
*synq.incidents.v1.IncidentsService*
`GET /api/incidents/v1` | |
| `BatchGetIssues`
*synq.issues.issues.v1.IssuesService*
`POST /api/issues/v1/by-id` | |
| `ListIssues`
*synq.issues.issues.v1.IssuesService*
`GET /api/issues/v1` | |
| `BatchGetIssues`
*synq.issues.v2.IssuesService*
`POST /api/issues/v2/by-id` | |
| `ListIssues`
*synq.issues.v2.IssuesService*
`GET /api/issues/v2` | |
| `History`
*synq.monitors.history.v1.HistoryService*
`GET /api/monitors/history/v1/{monitor_path}` | |
| `MonitorInfo`
*synq.monitors.info.v1.MonitorInfoService*
`GET /api/monitors/info/v1` | |
| `BatchGetLatestEntityMetrics`
*synq.monitors.predictions.v1.MonitorPredictionsService*
`POST /api/monitors/predictions/v1/entity-metrics:batchLatest` | Returns the most recent observed table-stats sample (row count, freshness) for each |
| `GetEntityMetrics`
*synq.monitors.predictions.v1.MonitorPredictionsService*
`GET /api/monitors/predictions/v1/entity-metrics` | Returns raw metric timeseries for an entity. Identity-aware: resolves |
| `GetMonitorPredictions`
*synq.monitors.predictions.v1.MonitorPredictionsService*
`GET /api/monitors/predictions/v1` | Returns prediction timeseries for a monitor. The monitor must exist |
| `BatchGet`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/batch-get` | Fetch multiple saved views by id. Ids the caller cannot see, or that do not |
| `List`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/list` | List the saved views the calling user can see. By default returns every |
| `SetPin`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/set-pin` | Pin or unpin a saved view to the calling user's main screen. Pinning is a |
| `GetByEmail`
*synq.users.v1.UsersService* | |
| `GetUserIdentities`
*synq.users.v1.UsersService* | Returns all canonical identity strings for a user. |
| `ListUsers`
*synq.users.v1.UsersService* | |
## MCP Write Access
`SCOPE_MCP_WRITE`
Use any write MCP (Model Context Protocol) tool, including tools added in the future.
*No public gRPC/REST methods require this scope directly (e.g. MCP tools or future methods).*
## Read Reconciliation Audits and Settings
`SCOPE_RECON_READ`
View reconciliation suites, settings, and audit results.
| Method | Description |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
| `GetAuditLog`
*synq.agent.recon.v1.AuditLogService* | GetAuditLog returns a single audit log by invocation ID. |
| `ListAuditLogs`
*synq.agent.recon.v1.AuditLogService* | ListAuditLogs returns audit logs ordered from newest to oldest, optionally filtered by suite and tim... |
| `BatchReconciliationRunState`
*synq.agent.recon.v1.RunStateService* | BatchReconciliationRunState returns the latest concluded run and any ongoing |
| `ListReconciliationRunState`
*synq.agent.recon.v1.RunStateService* | ListReconciliationRunState returns runs filtered by status and/or suite\_id. |
| `GetSuiteConfig`
*synq.agent.recon.v1.SuiteConfigService* | Get the latest version of a suite config by suite\_id. |
| `GetSuiteConfigVersion`
*synq.agent.recon.v1.SuiteConfigService* | Get a specific historical version of a suite config. |
| `ListSuiteConfigVersions`
*synq.agent.recon.v1.SuiteConfigService* | Get version history for a suite config. |
| `ListSuiteConfigs`
*synq.agent.recon.v1.SuiteConfigService* | List latest suite configs with filtering and pagination. |
| `GetSuiteDeployment`
*synq.agent.recon.v1.SuiteDeploymentService* | Fetch a deployment by suite\_id or deployment\_id. |
| `ListSuiteDeploymentHistory`
*synq.agent.recon.v1.SuiteDeploymentService* | List the append-only history of a deployment (every promote, |
| `ListSuiteDeployments`
*synq.agent.recon.v1.SuiteDeploymentService* | List deployments for the caller's workspace. Filters support answering |
## Read Check Categorisation Rules and Status
`SCOPE_POLICIES_READ`
View check categorisation rules and their status.
| Method | Description |
| -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `ListCheckCategories`
*synq.entities.checks.v1.ChecksCategoriesService*
`GET /api/entities/checks/v1/categories` | ListCheckCategories returns every explicit check category in the |
## Read Saved Views
`SCOPE_SAVED_VIEW_READ`
View saved views the caller has access to.
| Method | Description |
| ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------- |
| `BatchGet`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/batch-get` | Fetch multiple saved views by id. Ids the caller cannot see, or that do not |
| `List`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/list` | List the saved views the calling user can see. By default returns every |
| `SetPin`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/set-pin` | Pin or unpin a saved view to the calling user's main screen. Pinning is a |
## Create and Edit Saved Views
`SCOPE_SAVED_VIEW_EDIT`
Create, update, and delete the caller's own saved views.
| Method | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `Delete`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/delete` | Delete a saved view. Idempotent — deleting an already-deleted or unknown |
| `Upsert`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1` | Create or update a saved view. |
## Manage All Saved Views in the Workspace
`SCOPE_SAVED_VIEW_ADMIN`
Manage all saved views in the workspace, including those owned by other users.
| Method | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `Delete`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/delete` | Delete a saved view. Idempotent — deleting an already-deleted or unknown |
| `Upsert`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1` | Create or update a saved view. |
## 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.
| Method | Scopes |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `GenerateConnectionsYaml`
*synq.agent.dwh.v1.ConnectionsService* | `SCOPE_MCP_READ`
`SCOPE_EXTENSIONS_MANAGE`
`SCOPE_ENTITY_READ` |
| `ListConnections`
*synq.agent.dwh.v1.ConnectionsService* | `SCOPE_MCP_READ`
`SCOPE_EXTENSIONS_MANAGE`
`SCOPE_ENTITY_READ` |
| `GetAuditLog`
*synq.agent.recon.v1.AuditLogService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `ListAuditLogs`
*synq.agent.recon.v1.AuditLogService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `BatchReconciliationRunState`
*synq.agent.recon.v1.RunStateService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `ListReconciliationRunState`
*synq.agent.recon.v1.RunStateService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `GetSuiteConfig`
*synq.agent.recon.v1.SuiteConfigService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `GetSuiteConfigVersion`
*synq.agent.recon.v1.SuiteConfigService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `ListSuiteConfigVersions`
*synq.agent.recon.v1.SuiteConfigService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `ListSuiteConfigs`
*synq.agent.recon.v1.SuiteConfigService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `GetSuiteDeployment`
*synq.agent.recon.v1.SuiteDeploymentService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `ListSuiteDeploymentHistory`
*synq.agent.recon.v1.SuiteDeploymentService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `ListSuiteDeployments`
*synq.agent.recon.v1.SuiteDeploymentService* | `SCOPE_RECON_READ`
`SCOPE_MCP_READ` |
| `ParseYaml`
*synq.agent.recon.v1.YamlService*
`POST /api/agent/recon/v1/yaml/parse` | — |
| `RenderYaml`
*synq.agent.recon.v1.YamlService*
`POST /api/agent/recon/v1/yaml/render` | — |
| `SubmitFeatureRequest`
*synq.agent.sre.v1.FeatureRequestService*
`POST /api/feature-request/v1/submit` | `SCOPE_MCP_READ`
`SCOPE_ENTITY_READ`
`SCOPE_ISSUES_READ`
`SCOPE_INCIDENTS_READ`
`SCOPE_LINEAGE_READ`
`SCOPE_MONITORS_READ`
`SCOPE_EXECUTION_READ`
`SCOPE_CODE_READ`
`SCOPE_DATACHECKS_SQLTESTS_READ`
`SCOPE_DATACHECKS_TESTSUGGESTIONS_READ` |
| `AcceptPromptSuggestion`
*synq.agent.sre.v1.SreAgentService* | `SCOPE_INTEGRATION_EDIT` |
| `DismissPromptSuggestion`
*synq.agent.sre.v1.SreAgentService* | `SCOPE_INTEGRATION_EDIT` |
| `GetConfig`
*synq.agent.sre.v1.SreAgentService* | `SCOPE_MCP_READ` |
| `ListPromptSuggestions`
*synq.agent.sre.v1.SreAgentService* | `SCOPE_MCP_READ` |
| `RecordPromptSuggestion`
*synq.agent.sre.v1.SreAgentService* | `SCOPE_INTEGRATION_EDIT` |
| `BatchSuggestionStates`
*synq.agent.sre.v1.TestsSuggestionStateService* | `SCOPE_DATACHECKS_TESTSUGGESTIONS_READ`
`SCOPE_MCP_READ` |
| `GetActiveSuggestionStatesFor`
*synq.agent.sre.v1.TestsSuggestionStateService* | `SCOPE_DATACHECKS_TESTSUGGESTIONS_READ`
`SCOPE_MCP_READ` |
| `ListSuggestionStates`
*synq.agent.sre.v1.TestsSuggestionStateService* | `SCOPE_DATACHECKS_TESTSUGGESTIONS_READ`
`SCOPE_MCP_READ` |
| `MarkAsCancelled`
*synq.agent.sre.v1.TestsSuggestionStateService* | `SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT` |
| `MarkAsCompleted`
*synq.agent.sre.v1.TestsSuggestionStateService* | `SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT` |
| `MarkAsFailed`
*synq.agent.sre.v1.TestsSuggestionStateService* | `SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT` |
| `MarkAsRunning`
*synq.agent.sre.v1.TestsSuggestionStateService* | `SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT` |
| `SuggestFor`
*synq.agent.sre.v1.TestsSuggestionStateService* | `SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT` |
| `BatchLatestConclusions`
*synq.agent.sre.v1.TriageService*
`GET /api/triage/v1/conclusions` | `SCOPE_MCP_READ` |
| `BatchTriageState`
*synq.agent.sre.v1.TriageService*
`GET /api/triage/v1/states` | `SCOPE_MCP_READ` |
| `ListTriageState`
*synq.agent.sre.v1.TriageService*
`GET /api/triage/v1/statuses` | `SCOPE_MCP_READ` |
| `BatchGet`
*synq.alerts.services.v1.AlertsService*
`POST /api/alerts/v1/get` | `SCOPE_ALERTS_READ` |
| `Create`
*synq.alerts.services.v1.AlertsService*
`POST /api/alerts/v1` | `SCOPE_ALERTS_EDIT` |
| `Delete`
*synq.alerts.services.v1.AlertsService*
`DELETE /api/alerts/v1` | `SCOPE_ALERTS_EDIT` |
| `List`
*synq.alerts.services.v1.AlertsService*
`POST /api/alerts/v1/list` | `SCOPE_ALERTS_READ` |
| `ToggleEnabled`
*synq.alerts.services.v1.AlertsService*
`POST /api/alerts/v1/toggle` | `SCOPE_ALERTS_EDIT` |
| `Update`
*synq.alerts.services.v1.AlertsService*
`PUT /api/alerts/v1` | `SCOPE_ALERTS_EDIT` |
| `Iam`
*synq.auth.iam.v1.IamService*
`GET /api/iam/v1` | — |
| `BatchDeleteSqlTests`
*synq.datachecks.sqltests.v1.SqlTestsService*
`DELETE /api/datachecks/sqltests/v1` | `SCOPE_DATACHECKS_SQLTESTS_EDIT` |
| `BatchGetSqlTests`
*synq.datachecks.sqltests.v1.SqlTestsService*
`POST /api/datachecks/sqltests/v1/by-id` | `SCOPE_DATACHECKS_SQLTESTS_READ`
`SCOPE_MCP_READ` |
| `BatchUpsertSqlTests`
*synq.datachecks.sqltests.v1.SqlTestsService*
`POST /api/datachecks/sqltests/v1` | `SCOPE_DATACHECKS_SQLTESTS_EDIT` |
| `GetSqlTestAudit`
*synq.datachecks.sqltests.v1.SqlTestsService* | `SCOPE_DATACHECKS_SQLTESTS_AUDIT_READ` |
| `ListSqlTests`
*synq.datachecks.sqltests.v1.SqlTestsService*
`GET /api/datachecks/sqltests/v1` | `SCOPE_DATACHECKS_SQLTESTS_READ`
`SCOPE_MCP_READ` |
| `BatchAcceptTestSuggestions`
*synq.datachecks.testsuggestions.v1.TestSuggestionsService*
`PATCH /api/datachecks/testsuggestions/v1/accepted` | `SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT` |
| `BatchCreateTestSuggestions`
*synq.datachecks.testsuggestions.v1.TestSuggestionsService*
`POST /api/datachecks/testsuggestions/v1` | `SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT` |
| `BatchGetTestSuggestionsForEntities`
*synq.datachecks.testsuggestions.v1.TestSuggestionsService*
`GET /api/datachecks/testsuggestions/v1` | `SCOPE_DATACHECKS_TESTSUGGESTIONS_READ`
`SCOPE_MCP_READ` |
| `BatchRejectTestSuggestions`
*synq.datachecks.testsuggestions.v1.TestSuggestionsService*
`PATCH /api/datachecks/testsuggestions/v1/rejected` | `SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT` |
| `TriggerDatachecks`
*synq.datachecks.v1.TriggerService*
`POST /api/datachecks/scheduler/v1/trigger` | `SCOPE_DATACHECKS_TRIGGER` |
| `Delete`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/delete` | `SCOPE_DATAPRODUCT_EDIT` |
| `Get`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/get` | `SCOPE_DATAPRODUCT_READ`
`SCOPE_MCP_READ` |
| `List`
*synq.dataproducts.v1.DataproductsService*
`GET /api/dataproducts/v1` | `SCOPE_DATAPRODUCT_READ`
`SCOPE_MCP_READ` |
| `RemoveDefinitionPart`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/definition/part/delete` | `SCOPE_DATAPRODUCT_EDIT` |
| `SetDefinition`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/definition` | `SCOPE_DATAPRODUCT_EDIT` |
| `Upsert`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1` | `SCOPE_DATAPRODUCT_EDIT` |
| `UpsertDefinitionPart`
*synq.dataproducts.v1.DataproductsService*
`POST /api/dataproducts/v1/definition/part` | `SCOPE_DATAPRODUCT_EDIT` |
| `AddDomainMembers`
*synq.domains.members.v1.DomainMembersService* | `SCOPE_USER_ASSIGN` |
| `ListDomainMembers`
*synq.domains.members.v1.DomainMembersService* | `SCOPE_USER_READ` |
| `ListUserDomains`
*synq.domains.members.v1.DomainMembersService* | `SCOPE_USER_READ` |
| `RemoveDomainMembers`
*synq.domains.members.v1.DomainMembersService* | `SCOPE_USER_ASSIGN` |
| `SetDefaultUserDomain`
*synq.domains.members.v1.DomainMembersService* | `SCOPE_USER_READ` |
| `BatchGet`
*synq.domains.v1.DomainsService* | `SCOPE_DOMAIN_READ` |
| `Delete`
*synq.domains.v1.DomainsService* | `SCOPE_DOMAIN_EDIT` |
| `FetchDomainWithSubDomains`
*synq.domains.v1.DomainsService* | `SCOPE_DOMAIN_READ` |
| `List`
*synq.domains.v1.DomainsService* | `SCOPE_DOMAIN_READ` |
| `RemoveDefinitionPart`
*synq.domains.v1.DomainsService* | `SCOPE_DOMAIN_EDIT` |
| `SetDefinition`
*synq.domains.v1.DomainsService* | `SCOPE_DOMAIN_EDIT` |
| `Upsert`
*synq.domains.v1.DomainsService* | `SCOPE_DOMAIN_EDIT` |
| `UpsertDefinitionPart`
*synq.domains.v1.DomainsService* | `SCOPE_DOMAIN_EDIT` |
| `ListAnnotations`
*synq.entities.annotations.v1.AnnotationsService*
`GET /api/entities/annotations/v1` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `BatchChange`
*synq.entities.changes.v1.ChangesService*
`POST /api/changes/v1/by-id` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `List`
*synq.entities.changes.v1.ChangesService*
`GET /api/changes/v1` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `ListCheckCategories`
*synq.entities.checks.v1.ChecksCategoriesService*
`GET /api/entities/checks/v1/categories` | `SCOPE_POLICIES_READ` |
| `GetCoverage`
*synq.entities.checks.v1.ChecksCoverageService* | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `ListCode`
*synq.entities.code.v1.CodeService*
`GET /api/code/v1` | `SCOPE_CODE_READ`
`SCOPE_MCP_READ` |
| `GetTableConstraints`
*synq.entities.constraints.v1.TableConstraintsService*
`GET /api/constraints/v1/table-constraints` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `BatchDatabaseCoordinates`
*synq.entities.coordinates.v1.DatabaseCoordinatesService*
`POST /api/coordinates/v1/database/by-id` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `BatchIdsByCoordinates`
*synq.entities.coordinates.v1.DatabaseCoordinatesService*
`POST /api/coordinates/v1/database/by-fqn` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `DeleteCheckRelationships`
*synq.entities.custom.v1.ChecksRelationshipsService* | `SCOPE_ENTITY_EDIT` |
| `UpsertCheckRelationships`
*synq.entities.custom.v1.ChecksRelationshipsService* | `SCOPE_ENTITY_EDIT` |
| `DeleteEntity`
*synq.entities.custom.v1.EntitiesService*
`DELETE /api/entities/custom/v1/entities` | `SCOPE_ENTITY_EDIT` |
| `ListEntities`
*synq.entities.custom.v1.EntitiesService*
`GET /api/entities/custom/v1/entities` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `UpsertEntity`
*synq.entities.custom.v1.EntitiesService*
`POST /api/entities/custom/v1/entities` | `SCOPE_ENTITY_EDIT` |
| `UpsertExecution`
*synq.entities.custom.v1.EntityExecutionsService*
`POST /api/entities/custom/executions/v1` | `SCOPE_EXECUTION_EDIT` |
| `UpsertLogEntry`
*synq.entities.custom.v1.EntityExecutionsService*
`POST /api/entities/custom/executions/v1/log-entry` | `SCOPE_EXECUTION_EDIT`
`SCOPE_EXECUTION_LOG_EDIT` |
| `DeleteEntityFeature`
*synq.entities.custom.v1.FeaturesService*
`DELETE /api/entities/custom/v1/features` | `SCOPE_ENTITY_EDIT` |
| `ListEntityFeatures`
*synq.entities.custom.v1.FeaturesService*
`POST /api/entities/custom/v1/features/list` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `UpsertEntityFeature`
*synq.entities.custom.v1.FeaturesService*
`POST /api/entities/custom/v1/features` | `SCOPE_ENTITY_EDIT` |
| `DeleteEntitiesGroup`
*synq.entities.custom.v1.GroupsService*
`DELETE /api/entities/custom/v1/groups` | `SCOPE_ENTITY_EDIT` |
| `ListEntityGroups`
*synq.entities.custom.v1.GroupsService*
`POST /api/entities/custom/v1/groups/list` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `UpsertEntitiesGroup`
*synq.entities.custom.v1.GroupsService*
`POST /api/entities/custom/v1/groups` | `SCOPE_ENTITY_EDIT` |
| `DeleteRelationships`
*synq.entities.custom.v1.RelationshipsService*
`DELETE /api/entities/custom/v1/relationships` | `SCOPE_LINEAGE_EDIT` |
| `ListRelationships`
*synq.entities.custom.v1.RelationshipsService*
`POST /api/entities/custom/v1/relationships/list` | `SCOPE_LINEAGE_READ`
`SCOPE_MCP_READ` |
| `UpsertRelationships`
*synq.entities.custom.v1.RelationshipsService*
`POST /api/entities/custom/v1/relationships` | `SCOPE_LINEAGE_EDIT` |
| `DeleteType`
*synq.entities.custom.v1.TypesService*
`DELETE /api/entities/custom/v1/types` | `SCOPE_ENTITY_TYPE_EDIT` |
| `ListTypes`
*synq.entities.custom.v1.TypesService*
`POST /api/entities/custom/v1/types/list` | `SCOPE_ENTITY_READ`
`SCOPE_ENTITY_TYPE_READ` |
| `UpsertType`
*synq.entities.custom.v1.TypesService*
`POST /api/entities/custom/v1/types` | `SCOPE_ENTITY_TYPE_EDIT` |
| `BatchGetEntities`
*synq.entities.entities.v1.EntitiesService*
`POST /api/entities/v1/by-id` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `GetEntity`
*synq.entities.entities.v1.EntitiesService* | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `ListEntities`
*synq.entities.entities.v1.EntitiesService*
`GET /api/entities/v1` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `SearchEntities`
*synq.entities.entities.v1.EntitiesService*
`GET /api/entities/v1/search` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `UpsertExecution`
*synq.entities.executions.v1.EntityExecutionsService*
`POST /api/executions/v1` | `SCOPE_EXECUTION_EDIT` |
| `UpsertLogEntry`
*synq.entities.executions.v1.EntityExecutionsService*
`POST /api/executions/v1/log-entry` | `SCOPE_EXECUTION_EDIT`
`SCOPE_EXECUTION_LOG_EDIT` |
| `BatchGetExecutions`
*synq.entities.executions.v2.EntityExecutionsService*
`POST /api/executions/v2/by-id` | `SCOPE_EXECUTION_READ`
`SCOPE_MCP_READ` |
| `GetExecutionsSummary`
*synq.entities.executions.v2.EntityExecutionsService*
`POST /api/executions/v2/summary` | `SCOPE_EXECUTION_READ`
`SCOPE_MCP_READ` |
| `GetLatestExecutions`
*synq.entities.executions.v2.EntityExecutionsService*
`POST /api/executions/v2/latest` | `SCOPE_EXECUTION_READ`
`SCOPE_MCP_READ` |
| `ListExecutions`
*synq.entities.executions.v2.EntityExecutionsService*
`GET /api/executions/v2/list` | `SCOPE_EXECUTION_READ`
`SCOPE_MCP_READ` |
| `GetImpact`
*synq.entities.impact.v1.ImpactService*
`POST /api/impact/v1` | `SCOPE_ENTITY_READ`
`SCOPE_LINEAGE_READ`
`SCOPE_MCP_READ` |
| `GetLineage`
*synq.entities.lineage.v1.LineageService*
`POST /api/lineage/v1` | `SCOPE_LINEAGE_READ`
`SCOPE_MCP_READ` |
| `BatchOrchestration`
*synq.entities.orchestration.v1.OrchestrationService*
`GET /api/orchestration/v1` | `SCOPE_LINEAGE_READ`
`SCOPE_MCP_READ` |
| `BatchResolveIdentifiers`
*synq.entities.resolve.v1.IdentifierResolveService*
`POST /api/resolve/v1/by-id` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `BatchSchemaMismatches`
*synq.entities.schemas.v1.SchemaMismatchesService*
`POST /api/schema-mismatches/v1` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `GetSchema`
*synq.entities.schemas.v1.SchemasService*
`GET /api/schema/v1` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `BatchSqlDetails`
*synq.entities.sql\_insights.v1.SqlInsightsService*
`POST /api/sql-insights/v1/details:batch` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `ListSqlConstructs`
*synq.entities.sql\_insights.v1.SqlInsightsService*
`GET /api/sql-insights/v1/constructs` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `BatchGetIncidents`
*synq.entities.status.v1.EntityIncidentsService*
`POST /api/status/v1/incidents/by-id` | `SCOPE_STATUS_READ`
`SCOPE_MCP_READ` |
| `GetIncidents`
*synq.entities.status.v1.EntityIncidentsService* | `SCOPE_STATUS_READ`
`SCOPE_MCP_READ` |
| `BatchGetIssuesStatus`
*synq.entities.status.v1.EntityIssuesService*
`POST /api/status/v1/issues/by-id` | `SCOPE_STATUS_READ`
`SCOPE_MCP_READ` |
| `GetIssuesStatus`
*synq.entities.status.v1.EntityIssuesService* | `SCOPE_STATUS_READ` |
| `Activate`
*synq.extensions.atlan.integrations.v1.AtlanIntegrationService*
`PATCH /api/extensions/atlan/integrations/v1` | `SCOPE_EXTENSIONS_MANAGE` |
| `Ping`
*synq.extensions.atlan.integrations.v1.AtlanIntegrationService*
`POST /api/extensions/atlan/integrations/v1/ping` | `SCOPE_EXTENSIONS_MANAGE` |
| `Remove`
*synq.extensions.atlan.integrations.v1.AtlanIntegrationService*
`DELETE /api/extensions/atlan/integrations/v1` | `SCOPE_EXTENSIONS_MANAGE` |
| `Upsert`
*synq.extensions.atlan.integrations.v1.AtlanIntegrationService*
`POST /api/extensions/atlan/integrations/v1` | `SCOPE_EXTENSIONS_MANAGE` |
| `GetAtlanConnections`
*synq.extensions.atlan.provider.v1.AtlanProviderService*
`GET /api/extensions/atlan/provider/v1/connections` | `SCOPE_EXTENSIONS_MANAGE` |
| `GetAtlanDataProducts`
*synq.extensions.atlan.provider.v1.AtlanProviderService*
`GET /api/extensions/atlan/provider/v1/data-products` | `SCOPE_EXTENSIONS_MANAGE` |
| `GetAtlanDomains`
*synq.extensions.atlan.provider.v1.AtlanProviderService*
`GET /api/extensions/atlan/provider/v1/domains` | `SCOPE_EXTENSIONS_MANAGE` |
| `FetchRuns`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`GET /api/extensions/atlan/workflows/v1/runs` | `SCOPE_EXTENSIONS_MANAGE` |
| `GetConnectionMappings`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`GET /api/extensions/atlan/workflows/v1/connection-mappings` | `SCOPE_EXTENSIONS_MANAGE` |
| `GetDomainMappings`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`GET /api/extensions/atlan/workflows/v1/domain-mappings` | `SCOPE_EXTENSIONS_MANAGE` |
| `GetMappingToggles`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`GET /api/extensions/atlan/workflows/v1/mappings/toggle` | `SCOPE_EXTENSIONS_MANAGE` |
| `GetProductMappings`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`GET /api/extensions/atlan/workflows/v1/product-mappings` | `SCOPE_EXTENSIONS_MANAGE` |
| `RemoveConnectionMappings`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`DELETE /api/extensions/atlan/workflows/v1/connection-mappings` | `SCOPE_EXTENSIONS_MANAGE` |
| `SetConnectionMappings`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`POST /api/extensions/atlan/workflows/v1/connection-mappings` | `SCOPE_EXTENSIONS_MANAGE` |
| `SetMappingToggles`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`POST /api/extensions/atlan/workflows/v1/mappings/toggle` | `SCOPE_EXTENSIONS_MANAGE` |
| `Synchronize`
*synq.extensions.atlan.workflows.v1.AtlanWorkflowService*
`POST /api/extensions/atlan/workflows/v1/synchronize` | `SCOPE_EXTENSIONS_MANAGE` |
| `GetDiffByChangeId`
*synq.git.commits.v1.CommitsService*
`GET /api/git/v1/change/{change_id}` | `SCOPE_CODE_READ`
`SCOPE_MCP_READ` |
| `GetDiffByCommit`
*synq.git.commits.v1.CommitsService*
`GET /api/git/v1/commit/{commit_sha}` | `SCOPE_ENTITY_READ`
`SCOPE_MCP_READ` |
| `AddIssuesToIncident`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/{incident_id}/issues` | `SCOPE_INCIDENTS_EDIT` |
| `AssignIncidentOwner`
*synq.incidents.v1.IncidentsService*
`PATCH /api/incidents/v1/{incident_id}/assign-owner` | `SCOPE_INCIDENTS_EDIT` |
| `BatchGetIncidents`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/by-id` | `SCOPE_INCIDENTS_READ`
`SCOPE_MCP_READ` |
| `CancelIncident`
*synq.incidents.v1.IncidentsService*
`PATCH /api/incidents/v1/{incident_id}/cancel` | `SCOPE_INCIDENTS_EDIT` |
| `CloseIncident`
*synq.incidents.v1.IncidentsService*
`PATCH /api/incidents/v1/{incident_id}/close` | `SCOPE_INCIDENTS_EDIT` |
| `CreateIncident`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1` | `SCOPE_INCIDENTS_EDIT` |
| `ListIncidents`
*synq.incidents.v1.IncidentsService*
`GET /api/incidents/v1` | `SCOPE_INCIDENTS_READ`
`SCOPE_MCP_READ` |
| `MergeIncidents`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/{incident_id}/merge` | `SCOPE_INCIDENTS_EDIT` |
| `PostComment`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/{incident_id}/comment` | `SCOPE_INCIDENTS_EDIT` |
| `RemoveIssuesFromIncident`
*synq.incidents.v1.IncidentsService*
`DELETE /api/incidents/v1/{incident_id}/issues` | `SCOPE_INCIDENTS_EDIT` |
| `RenameIncident`
*synq.incidents.v1.IncidentsService*
`PATCH /api/incidents/v1/{incident_id}/rename` | `SCOPE_INCIDENTS_EDIT` |
| `SplitIncident`
*synq.incidents.v1.IncidentsService*
`POST /api/incidents/v1/{incident_id}/split` | `SCOPE_INCIDENTS_EDIT` |
| `UpdateIncidentState`
*synq.incidents.v1.IncidentsService*
`PATCH /api/incidents/v1/{incident_id}/state` | `SCOPE_INCIDENTS_EDIT` |
| `BatchGetIntegrations`
*synq.integrations.v1.IntegrationsService*
`POST /api/integrations/v1/by-id` | `SCOPE_INTEGRATION_EDIT` |
| `CreateIntegration`
*synq.integrations.v1.IntegrationsService*
`POST /api/integrations/v1` | `SCOPE_INTEGRATION_EDIT` |
| `DeleteIntegration`
*synq.integrations.v1.IntegrationsService*
`DELETE /api/integrations/v1/{integration_id}` | `SCOPE_INTEGRATION_EDIT` |
| `DisableIntegration`
*synq.integrations.v1.IntegrationsService*
`POST /api/integrations/v1/{integration_id}/disable` | `SCOPE_INTEGRATION_EDIT` |
| `EnableIntegration`
*synq.integrations.v1.IntegrationsService*
`POST /api/integrations/v1/{integration_id}/enable` | `SCOPE_INTEGRATION_EDIT` |
| `GetIntegration`
*synq.integrations.v1.IntegrationsService* | `SCOPE_INTEGRATION_EDIT` |
| `GetIntegrationHealth`
*synq.integrations.v1.IntegrationsService* | `SCOPE_INTEGRATION_EDIT` |
| `ListIntegrations`
*synq.integrations.v1.IntegrationsService*
`GET /api/integrations/v1` | `SCOPE_INTEGRATION_EDIT` |
| `RefreshIntegration`
*synq.integrations.v1.IntegrationsService*
`POST /api/integrations/v1/{integration_id}/refresh` | `SCOPE_INTEGRATION_EDIT` |
| `UpdateIntegration`
*synq.integrations.v1.IntegrationsService*
`PUT /api/integrations/v1/{integration_id}` | `SCOPE_INTEGRATION_EDIT` |
| `BatchGetIssues`
*synq.issues.issues.v1.IssuesService*
`POST /api/issues/v1/by-id` | `SCOPE_ISSUES_READ`
`SCOPE_MCP_READ` |
| `ListIssues`
*synq.issues.issues.v1.IssuesService*
`GET /api/issues/v1` | `SCOPE_ISSUES_READ`
`SCOPE_MCP_READ` |
| `MarkExpected`
*synq.issues.issues.v1.IssuesService*
`PATCH /api/issues/v1/{issue_id}/mark-expected` | `SCOPE_ISSUES_EDIT` |
| `MarkFixed`
*synq.issues.issues.v1.IssuesService*
`PATCH /api/issues/v1/{issue_id}/mark-fixed` | `SCOPE_ISSUES_EDIT` |
| `MarkInvestigating`
*synq.issues.issues.v1.IssuesService*
`PATCH /api/issues/v1/{issue_id}/mark-investigating` | `SCOPE_ISSUES_EDIT` |
| `MarkNoActionNeeded`
*synq.issues.issues.v1.IssuesService*
`PATCH /api/issues/v1/{issue_id}/mark-no-action-needed` | `SCOPE_ISSUES_EDIT` |
| `PostComment`
*synq.issues.issues.v1.IssuesService*
`POST /api/issues/v1/{issue_id}/comment` | `SCOPE_ISSUES_EDIT` |
| `BatchGetIssues`
*synq.issues.v2.IssuesService*
`POST /api/issues/v2/by-id` | `SCOPE_ISSUES_READ`
`SCOPE_MCP_READ` |
| `ClearStatus`
*synq.issues.v2.IssuesService*
`PATCH /api/issues/v2/{issue_id}/clear-status` | `SCOPE_ISSUES_EDIT` |
| `ListIssues`
*synq.issues.v2.IssuesService*
`GET /api/issues/v2` | `SCOPE_ISSUES_READ`
`SCOPE_MCP_READ` |
| `MarkExpected`
*synq.issues.v2.IssuesService*
`PATCH /api/issues/v2/{issue_id}/mark-expected` | `SCOPE_ISSUES_EDIT` |
| `MarkFixed`
*synq.issues.v2.IssuesService*
`PATCH /api/issues/v2/{issue_id}/mark-fixed` | `SCOPE_ISSUES_EDIT` |
| `MarkInvestigating`
*synq.issues.v2.IssuesService*
`PATCH /api/issues/v2/{issue_id}/mark-investigating` | `SCOPE_ISSUES_EDIT` |
| `MarkNoActionNeeded`
*synq.issues.v2.IssuesService*
`PATCH /api/issues/v2/{issue_id}/mark-no-action-needed` | `SCOPE_ISSUES_EDIT` |
| `PostComment`
*synq.issues.v2.IssuesService*
`POST /api/issues/v2/{issue_id}/comment` | `SCOPE_ISSUES_EDIT` |
| `BatchDeleteDeploymentRules`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`DELETE /api/monitors/automated/v1/deployment-rules/batch` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `BatchDeployDeploymentRules`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`POST /api/monitors/automated/v1/deployment-rules/batch/deployed` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `BatchGetDeploymentRules`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`GET /api/monitors/automated/v1/deployment-rules/batch` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `BatchUpdateDeploymentRuleTitle`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`PATCH /api/monitors/automated/v1/deployment-rules` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `BatchUpsertDeploymentRules`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`POST /api/monitors/automated/v1/deployment-rules/batch` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `DeleteDeploymentRule`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`DELETE /api/monitors/automated/v1/deployment-rule/{id}` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `DeployDeploymentRule`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`POST /api/monitors/automated/v1/deployment-rules/deployed` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `GetDeployDeleteOverview`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`GET /api/monitors/automated/v1/deployment-rule/{id}/deleted` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `GetDeployOverview`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`GET /api/monitors/automated/v1/deployment-rule` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `ListDeploymentRules`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`GET /api/monitors/automated/v1/deployment-rules` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `ListDeploymentRulesForAsset`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`GET /api/monitors/automated/v1/deployment-rules/{asset_path}` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `UpsertDeploymentRule`
*synq.monitors.automated\_monitors.v1.DeploymentRulesService*
`POST /api/monitors/automated/v1/deployment-rules` | `SCOPE_MONITORS_AUTOMATIC_EDIT` |
| `BatchCreateMonitor`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1` | `SCOPE_MONITORS_CUSTOM_EDIT`
`SCOPE_MONITORS_CUSTOM_SQL_EDIT` |
| `BatchDeleteMonitor`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1/delete` | `SCOPE_MONITORS_CUSTOM_EDIT` |
| `BatchUpdateMonitor`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`PUT /api/monitors/custom-monitors/v1` | `SCOPE_MONITORS_CUSTOM_EDIT`
`SCOPE_MONITORS_CUSTOM_SQL_EDIT` |
| `BatchUpdateMonitorMode`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1/mode` | `SCOPE_MONITORS_CUSTOM_EDIT` |
| `BatchUpdateMonitorSeverity`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1/severity` | `SCOPE_MONITORS_CUSTOM_EDIT` |
| `ConfigChangesOverview`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`POST /api/monitors/custom-monitors/v1/config-changes` | `SCOPE_MONITORS_CUSTOM_EDIT` |
| `ListConfigsMonitors`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`GET /api/monitors/custom-monitors/v1/by-config` | `SCOPE_MONITORS_READ` |
| `ListMonitors`
*synq.monitors.custom\_monitors.v1.CustomMonitorsService*
`GET /api/monitors/custom-monitors/v1` | `SCOPE_MONITORS_READ` |
| `History`
*synq.monitors.history.v1.HistoryService*
`GET /api/monitors/history/v1/{monitor_path}` | `SCOPE_MONITORS_READ`
`SCOPE_MCP_READ` |
| `MonitorInfo`
*synq.monitors.info.v1.MonitorInfoService*
`GET /api/monitors/info/v1` | `SCOPE_MONITORS_READ`
`SCOPE_MCP_READ` |
| `BatchGetLatestEntityMetrics`
*synq.monitors.predictions.v1.MonitorPredictionsService*
`POST /api/monitors/predictions/v1/entity-metrics:batchLatest` | `SCOPE_MONITORS_READ`
`SCOPE_MCP_READ` |
| `GetEntityMetrics`
*synq.monitors.predictions.v1.MonitorPredictionsService*
`GET /api/monitors/predictions/v1/entity-metrics` | `SCOPE_MONITORS_READ`
`SCOPE_MCP_READ` |
| `GetMonitorPredictions`
*synq.monitors.predictions.v1.MonitorPredictionsService*
`GET /api/monitors/predictions/v1` | `SCOPE_MONITORS_READ`
`SCOPE_MCP_READ` |
| `SetPlatformAuthentication`
*synq.platforms.v1.PlatformsService*
`POST /api/platforms/v1` | `SCOPE_INTEGRATION_EDIT` |
| `GenerateQuery`
*synq.queries.v1.NLQueryService*
`POST /api/queries/v1/generate` | `SCOPE_ENTITY_READ` |
| `BatchGet`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/batch-get` | `SCOPE_SAVED_VIEW_READ`
`SCOPE_MCP_READ` |
| `Delete`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/delete` | `SCOPE_SAVED_VIEW_EDIT`
`SCOPE_SAVED_VIEW_ADMIN` |
| `List`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/list` | `SCOPE_SAVED_VIEW_READ`
`SCOPE_MCP_READ` |
| `SetPin`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1/set-pin` | `SCOPE_SAVED_VIEW_READ`
`SCOPE_MCP_READ` |
| `Upsert`
*synq.savedviews.v1.SavedViewsService*
`POST /api/saved-views/v1` | `SCOPE_SAVED_VIEW_EDIT`
`SCOPE_SAVED_VIEW_ADMIN` |
| `PreviewSchedules`
*synq.schedule.v1.ScheduleService*
`POST /api/schedule/v1/preview` | — |
| `BatchGetUsers`
*synq.users.v1.UsersService* | `SCOPE_USER_READ` |
| `DeleteUserAliases`
*synq.users.v1.UsersService* | `SCOPE_USER_EDIT` |
| `GetByAlias`
*synq.users.v1.UsersService* | `SCOPE_USER_READ` |
| `GetByEmail`
*synq.users.v1.UsersService* | `SCOPE_USER_READ`
`SCOPE_MCP_READ` |
| `GetUserAliases`
*synq.users.v1.UsersService* | `SCOPE_USER_READ` |
| `GetUserIdentities`
*synq.users.v1.UsersService* | `SCOPE_USER_READ`
`SCOPE_MCP_READ` |
| `ListUsers`
*synq.users.v1.UsersService* | `SCOPE_USER_READ`
`SCOPE_MCP_READ` |
| `UpsertUserAliases`
*synq.users.v1.UsersService* | `SCOPE_USER_EDIT` |