ListMembers

curl --request GET \
  --url https://developer.synq.io/api/entities/folders/v1/members \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developer.synq.io/api/entities/folders/v1/members"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developer.synq.io/api/entities/folders/v1/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developer.synq.io/api/entities/folders/v1/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://developer.synq.io/api/entities/folders/v1/members"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://developer.synq.io/api/entities/folders/v1/members")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/entities/folders/v1/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "entityIds": [
    "<string>"
  ],
  "pageInfo": {
    "totalCount": 123,
    "count": 123,
    "lastId": "<string>"
  }
}

synq.entities.folders.v1.FoldersService

ListMembers

List the entity ids contained in a folder, paginated. Direct members only by default; set deep = true to include members of all nested sub-folders. Narrow with types and/or filter.

Pagination is a stable client-side window over the folder’s fully-resolved member set: each page recomputes and re-orders that set, then returns the requested slice. Results are consistent, but paging deep through a very large folder repeats work — prefer a larger page_size over many small pages.

GET

api

entities

folders

members

ListMembers

curl --request GET \
  --url https://developer.synq.io/api/entities/folders/v1/members \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developer.synq.io/api/entities/folders/v1/members"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developer.synq.io/api/entities/folders/v1/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developer.synq.io/api/entities/folders/v1/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://developer.synq.io/api/entities/folders/v1/members"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://developer.synq.io/api/entities/folders/v1/members")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/entities/folders/v1/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "entityIds": [
    "<string>"
  ],
  "pageInfo": {
    "totalCount": 123,
    "count": 123,
    "lastId": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

folderEntityId

string

Opaque id of the folder (from Folder.folder_entity_id).

folderRef.rootEntityId

string

Opaque id of the entity the folder hierarchy hangs under — an integration root or container (for example a warehouse instance, a database, or a transformation project). Take it verbatim from FolderRef.root_entity_id of a folder you already read, or from an entity id returned elsewhere.

folderRef.folders

string[]

Ordered folder names from the root down to this folder (root first, leaf last), for example ["staging", "sales"]. Empty means the ref points at the root entity itself. Folder names are kept as separate segments (not joined with "/") because some platforms allow "/" inside a single folder name.

deep

boolean

When true, include entities in all nested sub-folders. When false (default), return only the entities placed directly in this folder.

types

enum<string>[]

Optional entity-type filter. Empty returns all types.

Available options:

ENTITY_TYPE_UNSPECIFIED,

ENTITY_TYPE_BQ_TABLE,

ENTITY_TYPE_BQ_VIEW,

ENTITY_TYPE_LOOKER_LOOK,

ENTITY_TYPE_LOOKER_EXPLORE,

ENTITY_TYPE_LOOKER_VIEW,

ENTITY_TYPE_LOOKER_DASHBOARD,

ENTITY_TYPE_DBT_MODEL,

ENTITY_TYPE_DBT_TEST,

ENTITY_TYPE_DBT_SOURCE,

ENTITY_TYPE_DBT_PROJECT,

ENTITY_TYPE_DBT_METRIC,

ENTITY_TYPE_DBT_SNAPSHOT,

ENTITY_TYPE_DBT_SEED,

ENTITY_TYPE_DBT_ANALYSIS,

ENTITY_TYPE_DBT_EXPOSURE,

ENTITY_TYPE_DBT_GROUP,

ENTITY_TYPE_DBT_SEMANTIC_MODEL,

ENTITY_TYPE_DBT_CLOUD_PROJECT,

ENTITY_TYPE_DBT_CLOUD_JOB,

ENTITY_TYPE_SNOWFLAKE_TABLE,

ENTITY_TYPE_SNOWFLAKE_VIEW,

ENTITY_TYPE_SNOWFLAKE_STREAM,

ENTITY_TYPE_SNOWFLAKE_DYNAMIC_TABLE,

ENTITY_TYPE_SNOWFLAKE_TASK,

ENTITY_TYPE_SNOWFLAKE_EXTERNAL_TABLE,

ENTITY_TYPE_SNOWFLAKE_MATERIALIZED_VIEW,

ENTITY_TYPE_SNOWFLAKE_PROCEDURE,

ENTITY_TYPE_SNOWFLAKE_FUNCTION,

ENTITY_TYPE_SNOWFLAKE_SEMANTIC_VIEW,

ENTITY_TYPE_REDSHIFT_TABLE,

ENTITY_TYPE_REDSHIFT_VIEW,

ENTITY_TYPE_REDSHIFT_PROCEDURE,

ENTITY_TYPE_REDSHIFT_FUNCTION,

ENTITY_TYPE_TABLEAU_EMBEDDED,

ENTITY_TYPE_TABLEAU_PUBLISHED,

ENTITY_TYPE_TABLEAU_CUSTOM_SQL,

ENTITY_TYPE_TABLEAU_TABLE,

ENTITY_TYPE_TABLEAU_SHEET,

ENTITY_TYPE_TABLEAU_DASHBOARD,

ENTITY_TYPE_AIRFLOW_DAG,

ENTITY_TYPE_AIRFLOW_TASK,

ENTITY_TYPE_CLICKHOUSE_TABLE,

ENTITY_TYPE_CLICKHOUSE_VIEW,

ENTITY_TYPE_ANOMALY_MONITOR,

ENTITY_TYPE_ANOMALY_MONITOR_SEGMENT,

ENTITY_TYPE_SQLTEST_TEST,

ENTITY_TYPE_RECON_SUITE,

ENTITY_TYPE_RECON_CASE,

ENTITY_TYPE_POSTGRES_TABLE,

ENTITY_TYPE_POSTGRES_VIEW,

ENTITY_TYPE_MYSQL_TABLE,

ENTITY_TYPE_MYSQL_VIEW,

ENTITY_TYPE_DATABRICKS_WAREHOUSE,

ENTITY_TYPE_DATABRICKS_TABLE,

ENTITY_TYPE_DATABRICKS_VIEW,

ENTITY_TYPE_DATABRICKS_JOB,

ENTITY_TYPE_DATABRICKS_JOB_TASK,

ENTITY_TYPE_DATABRICKS_NOTEBOOK,

ENTITY_TYPE_DATABRICKS_QUERY,

ENTITY_TYPE_DATABRICKS_DASHBOARD,

ENTITY_TYPE_SQLMESH_PROJECT,

ENTITY_TYPE_SQLMESH_SQL_MODEL,

ENTITY_TYPE_SQLMESH_PYTHON_MODEL,

ENTITY_TYPE_SQLMESH_EXTERNAL,

ENTITY_TYPE_SQLMESH_SEED,

ENTITY_TYPE_SQLMESH_AUDIT,

ENTITY_TYPE_SQLMESH_UNIT_TEST,

ENTITY_TYPE_SQLMESH_ENVIRONMENT,

ENTITY_TYPE_SQLMESH_SNAPSHOT,

ENTITY_TYPE_DUCKDB_TABLE,

ENTITY_TYPE_DUCKDB_VIEW,

ENTITY_TYPE_TRINO_TABLE,

ENTITY_TYPE_TRINO_VIEW,

ENTITY_TYPE_ATLAN_ASSET,

ENTITY_TYPE_ATLAN_INTEGRATION,

ENTITY_TYPE_COALESCE_PROJECT,

ENTITY_TYPE_COALESCE_ENVIRONMENT,

ENTITY_TYPE_COALESCE_NODE,

ENTITY_TYPE_COALESCE_NODE_TEST,

ENTITY_TYPE_COALESCE_JOB,

ENTITY_TYPE_CASTORDOC_TABLE,

ENTITY_TYPE_CASTORDOC_DASHBOARD,

ENTITY_TYPE_CASTORDOC_VIEW,

ENTITY_TYPE_CASTORDOC_TILE,

ENTITY_TYPE_CASTORDOC_VIZ_MODEL,

ENTITY_TYPE_POWERBI_REPORT,

ENTITY_TYPE_POWERBI_TILE,

ENTITY_TYPE_POWERBI_DATASET,

ENTITY_TYPE_POWERBI_DASHBOARD,

ENTITY_TYPE_POWERBI_TENANT,

ENTITY_TYPE_THOUGHTSPOT_LIVEBOARD,

ENTITY_TYPE_THOUGHTSPOT_WORKSHEET,

ENTITY_TYPE_SIGMA_WORKBOOK,

ENTITY_TYPE_SIGMA_DATA_MODEL,

ENTITY_TYPE_DOMO_PAGE,

ENTITY_TYPE_DOMO_DATASET,

ENTITY_TYPE_MSSQL_TABLE,

ENTITY_TYPE_MSSQL_VIEW,

ENTITY_TYPE_ORACLE_TABLE,

ENTITY_TYPE_ORACLE_VIEW,

ENTITY_TYPE_ATHENA_TABLE,

ENTITY_TYPE_ATHENA_VIEW,

ENTITY_TYPE_FABRIC_TABLE,

ENTITY_TYPE_FABRIC_VIEW,

ENTITY_TYPE_CUSTOM_ENTITY_GENERIC,

ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN,

ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX

filter.parts.identifierList.identifiers.dbtCoreNode.integrationId

string

required

Opaque identifier of the dbt Core project. Usually the Coalesce Quality integration id (a UUID), but may also be the dbt project name from manifest.json when the integration is configured to identify assets by project name. Treat it as an opaque string, not a UUID.

filter.parts.identifierList.identifiers.dbtCoreNode.nodeId

string

required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

filter.parts.identifierList.identifiers.dbtCloudNode.projectId

string

required

Your dbt Cloud project id

filter.parts.identifierList.identifiers.dbtCloudNode.accountId

string

Your dbt Cloud account id

filter.parts.identifierList.identifiers.dbtCloudNode.nodeId

string

required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

filter.parts.identifierList.identifiers.bigqueryTable.project

string

required

BigQuery project

filter.parts.identifierList.identifiers.bigqueryTable.dataset

string

required

BigQuery dataset id

filter.parts.identifierList.identifiers.bigqueryTable.table

string

required

BigQuery table name

filter.parts.identifierList.identifiers.snowflakeTable.account

string

required

Snowflake account

filter.parts.identifierList.identifiers.snowflakeTable.database

string

required

Snowflake database

filter.parts.identifierList.identifiers.snowflakeTable.schema

string

required

Snowflake schema

filter.parts.identifierList.identifiers.snowflakeTable.table

string

required

Snowflake table

filter.parts.identifierList.identifiers.redshiftTable.cluster

string

Redshift cluster

filter.parts.identifierList.identifiers.redshiftTable.database

string

required

Redshift database

filter.parts.identifierList.identifiers.redshiftTable.schema

string

required

Redshift schema

filter.parts.identifierList.identifiers.redshiftTable.table

string

required

Redshift table

filter.parts.identifierList.identifiers.postgresTable.host

string

required

Postgres hostname without port

filter.parts.identifierList.identifiers.postgresTable.database

string

required

Postgres database

filter.parts.identifierList.identifiers.postgresTable.schema

string

required

Postgres schema

filter.parts.identifierList.identifiers.postgresTable.table

string

required

Postgres table

filter.parts.identifierList.identifiers.mysqlTable.host

string

required

Mysql hostname without port

filter.parts.identifierList.identifiers.mysqlTable.schema

string

required

Mysql database

filter.parts.identifierList.identifiers.mysqlTable.table

string

required

Mysql table

filter.parts.identifierList.identifiers.clickhouseTable.host

string

required

Clickhouse hostname without port

filter.parts.identifierList.identifiers.clickhouseTable.schema

string

required

Clickhouse database

filter.parts.identifierList.identifiers.clickhouseTable.table

string

required

Clickhouse table

filter.parts.identifierList.identifiers.airflowDag.integrationId

string

required

Coalesce Quality integration_id that identifies the Airflow instance

filter.parts.identifierList.identifiers.airflowDag.dagId

string

required

Airflow dag_id that identifies the DAG

filter.parts.identifierList.identifiers.airflowTask.integrationId

string

required

Coalesce Quality integration_id that identifies the Airflow instance

filter.parts.identifierList.identifiers.airflowTask.dagId

string

required

Airflow dag_id that identifies the DAG

filter.parts.identifierList.identifiers.airflowTask.taskId

string

required

Airflow task_id that identifies the task within the DAG

filter.parts.identifierList.identifiers.custom.id

string

required

Id that identifies the custom entity The Id should be unique within the custom entity Identifier.

filter.parts.identifierList.identifiers.dataproduct.id

string<uuid>

required

Dataproduct id that identifies the Dataproduct

filter.parts.identifierList.identifiers.synqPath.path

string

required

Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths

filter.parts.identifierList.identifiers.databricksTable.workspace

string

required

URL of Databricks workspace

filter.parts.identifierList.identifiers.databricksTable.catalog

string

required

Databricks catalog

filter.parts.identifierList.identifiers.databricksTable.schema

string

required

Databricks schema

filter.parts.identifierList.identifiers.databricksTable.table

string

required

Databricks table or view

filter.parts.identifierList.identifiers.trinoTable.host

string

required

Hostname of the Trino instance

filter.parts.identifierList.identifiers.trinoTable.catalog

string

required

Trino catalog

filter.parts.identifierList.identifiers.trinoTable.schema

string

required

Trino schema

filter.parts.identifierList.identifiers.trinoTable.table

string

required

Trino table or view

filter.parts.identifierList.identifiers.sqlMeshModel.integrationId

string<uuid>

required

Coalesce Quality integration_id that identifies the dbt Core project

filter.parts.identifierList.identifiers.sqlMeshModel.fqn

string

required

SQLMesh model fully qualified name

filter.parts.identifierList.identifiers.sqlMeshAudit.integrationId

string<uuid>

required

Coalesce Quality integration_id that identifies the dbt Core project

filter.parts.identifierList.identifiers.sqlMeshAudit.fqn

string

required

SQLMesh model fully qualified name

filter.parts.identifierList.identifiers.sqlMeshAudit.auditId

string

required

Identifier of the audit

filter.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.host

string

required

Hostname of the SQL Server instance

filter.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.database

string

required

SQL Server database

filter.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.schema

string

required

SQL Server schema (e.g. "dbo")

filter.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.table

string

required

SQL Server table or view

filter.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.host

string

required

Hostname of the Oracle instance

filter.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.serviceName

string

required

Oracle service name (PDB)

filter.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.schema

string

required

Oracle schema (= owning user)

filter.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.table

string

required

Oracle table or view

filter.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.instance

string

required

AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived from sts:GetCallerIdentity at integration setup time.

filter.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.catalog

string

required

Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog.

filter.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.database

string

required

Glue database (the namespace users typically filter on).

filter.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.table

string

required

Glue table or view name.

filter.parts.identifierList.identifiers.monitor.monitoredId.savedView.id

string<uuid>

required

Saved view id (client-supplied UUID) that identifies the saved view

filter.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.instance

string

required

Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com".

filter.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.database

string

required

Fabric warehouse / lakehouse (database).

filter.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.schema

string

required

Schema within the database.

filter.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.table

string

required

Table or view name.

filter.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.workspaceId

string

Fabric workspace GUID, decoded from the endpoint host in instance. Optional and informational: the table is addressed by instance/database/schema/table, so leave it empty if you don't have it — it does not affect how the identifier resolves.

filter.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.tenantId

string

Entra (Azure AD) tenant GUID, decoded from the endpoint host in instance. Optional and informational, like workspace_id.

filter.parts.identifierList.identifiers.monitor.monitorId

string

required

Identifier of the monitor

filter.parts.identifierList.identifiers.monitor.segment

string

Optional monitor segmentation identifier

filter.parts.identifierList.identifiers.monitor.integrationId

string

deprecated

Coalesce Quality integration_id of the monitored identifier

filter.parts.withNameSearch.searchQuery

string

filter.parts.withType.type.default

enum<string>

Default Coalesce Quality types

Available options:

ENTITY_TYPE_UNSPECIFIED,

ENTITY_TYPE_BQ_TABLE,

ENTITY_TYPE_BQ_VIEW,

ENTITY_TYPE_LOOKER_LOOK,

ENTITY_TYPE_LOOKER_EXPLORE,

ENTITY_TYPE_LOOKER_VIEW,

ENTITY_TYPE_LOOKER_DASHBOARD,

ENTITY_TYPE_DBT_MODEL,

ENTITY_TYPE_DBT_TEST,

ENTITY_TYPE_DBT_SOURCE,

ENTITY_TYPE_DBT_PROJECT,

ENTITY_TYPE_DBT_METRIC,

ENTITY_TYPE_DBT_SNAPSHOT,

ENTITY_TYPE_DBT_SEED,

ENTITY_TYPE_DBT_ANALYSIS,

ENTITY_TYPE_DBT_EXPOSURE,

ENTITY_TYPE_DBT_GROUP,

ENTITY_TYPE_DBT_SEMANTIC_MODEL,

ENTITY_TYPE_DBT_CLOUD_PROJECT,

ENTITY_TYPE_DBT_CLOUD_JOB,

ENTITY_TYPE_SNOWFLAKE_TABLE,

ENTITY_TYPE_SNOWFLAKE_VIEW,

ENTITY_TYPE_SNOWFLAKE_STREAM,

ENTITY_TYPE_SNOWFLAKE_DYNAMIC_TABLE,

ENTITY_TYPE_SNOWFLAKE_TASK,

ENTITY_TYPE_SNOWFLAKE_EXTERNAL_TABLE,

ENTITY_TYPE_SNOWFLAKE_MATERIALIZED_VIEW,

ENTITY_TYPE_SNOWFLAKE_PROCEDURE,

ENTITY_TYPE_SNOWFLAKE_FUNCTION,

ENTITY_TYPE_SNOWFLAKE_SEMANTIC_VIEW,

ENTITY_TYPE_REDSHIFT_TABLE,

ENTITY_TYPE_REDSHIFT_VIEW,

ENTITY_TYPE_REDSHIFT_PROCEDURE,

ENTITY_TYPE_REDSHIFT_FUNCTION,

ENTITY_TYPE_TABLEAU_EMBEDDED,

ENTITY_TYPE_TABLEAU_PUBLISHED,

ENTITY_TYPE_TABLEAU_CUSTOM_SQL,

ENTITY_TYPE_TABLEAU_TABLE,

ENTITY_TYPE_TABLEAU_SHEET,

ENTITY_TYPE_TABLEAU_DASHBOARD,

ENTITY_TYPE_AIRFLOW_DAG,

ENTITY_TYPE_AIRFLOW_TASK,

ENTITY_TYPE_CLICKHOUSE_TABLE,

ENTITY_TYPE_CLICKHOUSE_VIEW,

ENTITY_TYPE_ANOMALY_MONITOR,

ENTITY_TYPE_ANOMALY_MONITOR_SEGMENT,

ENTITY_TYPE_SQLTEST_TEST,

ENTITY_TYPE_RECON_SUITE,

ENTITY_TYPE_RECON_CASE,

ENTITY_TYPE_POSTGRES_TABLE,

ENTITY_TYPE_POSTGRES_VIEW,

ENTITY_TYPE_MYSQL_TABLE,

ENTITY_TYPE_MYSQL_VIEW,

ENTITY_TYPE_DATABRICKS_WAREHOUSE,

ENTITY_TYPE_DATABRICKS_TABLE,

ENTITY_TYPE_DATABRICKS_VIEW,

ENTITY_TYPE_DATABRICKS_JOB,

ENTITY_TYPE_DATABRICKS_JOB_TASK,

ENTITY_TYPE_DATABRICKS_NOTEBOOK,

ENTITY_TYPE_DATABRICKS_QUERY,

ENTITY_TYPE_DATABRICKS_DASHBOARD,

ENTITY_TYPE_SQLMESH_PROJECT,

ENTITY_TYPE_SQLMESH_SQL_MODEL,

ENTITY_TYPE_SQLMESH_PYTHON_MODEL,

ENTITY_TYPE_SQLMESH_EXTERNAL,

ENTITY_TYPE_SQLMESH_SEED,

ENTITY_TYPE_SQLMESH_AUDIT,

ENTITY_TYPE_SQLMESH_UNIT_TEST,

ENTITY_TYPE_SQLMESH_ENVIRONMENT,

ENTITY_TYPE_SQLMESH_SNAPSHOT,

ENTITY_TYPE_DUCKDB_TABLE,

ENTITY_TYPE_DUCKDB_VIEW,

ENTITY_TYPE_TRINO_TABLE,

ENTITY_TYPE_TRINO_VIEW,

ENTITY_TYPE_ATLAN_ASSET,

ENTITY_TYPE_ATLAN_INTEGRATION,

ENTITY_TYPE_COALESCE_PROJECT,

ENTITY_TYPE_COALESCE_ENVIRONMENT,

ENTITY_TYPE_COALESCE_NODE,

ENTITY_TYPE_COALESCE_NODE_TEST,

ENTITY_TYPE_COALESCE_JOB,

ENTITY_TYPE_CASTORDOC_TABLE,

ENTITY_TYPE_CASTORDOC_DASHBOARD,

ENTITY_TYPE_CASTORDOC_VIEW,

ENTITY_TYPE_CASTORDOC_TILE,

ENTITY_TYPE_CASTORDOC_VIZ_MODEL,

ENTITY_TYPE_POWERBI_REPORT,

ENTITY_TYPE_POWERBI_TILE,

ENTITY_TYPE_POWERBI_DATASET,

ENTITY_TYPE_POWERBI_DASHBOARD,

ENTITY_TYPE_POWERBI_TENANT,

ENTITY_TYPE_THOUGHTSPOT_LIVEBOARD,

ENTITY_TYPE_THOUGHTSPOT_WORKSHEET,

ENTITY_TYPE_SIGMA_WORKBOOK,

ENTITY_TYPE_SIGMA_DATA_MODEL,

ENTITY_TYPE_DOMO_PAGE,

ENTITY_TYPE_DOMO_DATASET,

ENTITY_TYPE_MSSQL_TABLE,

ENTITY_TYPE_MSSQL_VIEW,

ENTITY_TYPE_ORACLE_TABLE,

ENTITY_TYPE_ORACLE_VIEW,

ENTITY_TYPE_ATHENA_TABLE,

ENTITY_TYPE_ATHENA_VIEW,

ENTITY_TYPE_FABRIC_TABLE,

ENTITY_TYPE_FABRIC_VIEW,

ENTITY_TYPE_CUSTOM_ENTITY_GENERIC,

ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN,

ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX

filter.parts.withType.type.custom

integer<int32>

Custom types as defined through synq.entities.custom.v1.TypesService

filter.parts.withAnnotation.name

string

filter.parts.withAnnotation.acceptedValue

string

deprecated

filter.parts.withAnnotation.acceptedValues

string[]

filter.parts.inDataPlatform.identifier.bigquery.project

string

required

BigQuery project

filter.parts.inDataPlatform.identifier.clickhouse.host

string

required

Clickhouse host inclusive of port

filter.parts.inDataPlatform.identifier.clickhouse.schema

string

required

Clickhouse database

filter.parts.inDataPlatform.identifier.snowflake.account

string

required

Snowflake account

filter.parts.inDataPlatform.identifier.snowflake.database

string

required

Snowflake database

filter.parts.inDataPlatform.identifier.redshift.cluster

string

required

Redshift cluster

filter.parts.inDataPlatform.identifier.redshift.database

string

required

Redshift database

filter.parts.inDataPlatform.identifier.postgres.host

string

required

Postgres host inclusive of port

filter.parts.inDataPlatform.identifier.postgres.database

string

required

Postgres database

filter.parts.inDataPlatform.identifier.mysql.host

string

required

Mysql host inclusive of port

filter.parts.inDataPlatform.identifier.databricks.workspace

string

required

URL of the databricks workspace

filter.parts.inDataPlatform.identifier.dbtCloud.apiEndpoint

string

required

API endpoint for Dbt Cloud

filter.parts.inDataPlatform.identifier.dbtCloud.accountId

string

required

Account ID

filter.parts.inDataPlatform.identifier.dbtCloud.projectId

string

required

Project ID

filter.parts.inDataPlatform.identifier.sqlMesh.defaultDatabaseInstance

string

required

Default database instance for SQL Mesh

filter.parts.inDataPlatform.identifier.duckdb.motherduckAccount

string

filter.parts.inDataPlatform.identifier.trino.coordinator

string

filter.parts.inDataPlatform.identifier.mssql.host

string

required

SQL Server host

filter.parts.inDataPlatform.identifier.mssql.database

string

required

Database name

filter.parts.inDataPlatform.identifier.oracle.host

string

required

Oracle host

filter.parts.inDataPlatform.identifier.oracle.serviceName

string

required

Oracle service name (PDB)

filter.parts.inDataPlatform.identifier.athena.instance

string

required

AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived by SYNQ from sts:GetCallerIdentity at integration setup time.

filter.parts.inDataPlatform.identifier.athena.catalog

string

required

Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog.

filter.parts.inDataPlatform.identifier.fabric.instance

string

required

Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". Identifies the Fabric workspace the integration connects to. Fabric is workspace-scoped with cross-database queries, so the workspace host alone identifies the platform (like Databricks' workspace URL); a specific warehouse/table is addressed by FabricTableIdentifier.

filter.parts.inDataPlatform.identifier.fabric.workspaceId

string

Fabric workspace GUID — the identifier used by the Fabric REST API for workspace-scoped resources. The Fabric endpoint host in instance encodes the tenant and workspace GUIDs; this is the decoded workspace GUID, provided so you don't have to decode it yourself. instance remains the identifying value. Optional: empty when the host isn't a standard Fabric endpoint.

filter.parts.inDataPlatform.identifier.fabric.tenantId

string

Entra (Azure AD) tenant GUID, decoded from the endpoint host in instance alongside workspace_id. Optional: empty when the host isn't a standard Fabric endpoint.

filter.parts.inDataPlatform.identifier.synqIntegrationId

string

Coalesce Quality integration ID maps to the created integration on the Coalesce Quality platform.

filter.parts.withDataPlatformType.types

enum<string>[]

Available options:

DATA_PLATFORM_TYPE_UNSPECIFIED,

DATA_PLATFORM_TYPE_BIGQUERY,

DATA_PLATFORM_TYPE_LOOKER,

DATA_PLATFORM_TYPE_DBT,

DATA_PLATFORM_TYPE_DBT_CLOUD,

DATA_PLATFORM_TYPE_DBT_SELF_HOSTED,

DATA_PLATFORM_TYPE_SNOWFLAKE,

DATA_PLATFORM_TYPE_GCP,

DATA_PLATFORM_TYPE_GIT,

DATA_PLATFORM_TYPE_GITHUB,

DATA_PLATFORM_TYPE_REDSHIFT,

DATA_PLATFORM_TYPE_TABLEAU,

DATA_PLATFORM_TYPE_AIRFLOW,

DATA_PLATFORM_TYPE_CLICKHOUSE,

DATA_PLATFORM_TYPE_POSTGRES,

DATA_PLATFORM_TYPE_MYSQL,

DATA_PLATFORM_TYPE_DATABRICKS,

DATA_PLATFORM_TYPE_SQLMESH,

DATA_PLATFORM_TYPE_DUCKDB,

DATA_PLATFORM_TYPE_TRINO,

DATA_PLATFORM_TYPE_ATLAN,

DATA_PLATFORM_TYPE_COALESCE,

DATA_PLATFORM_TYPE_CASTORDOC,

DATA_PLATFORM_TYPE_POWERBI,

DATA_PLATFORM_TYPE_THOUGHTSPOT,

DATA_PLATFORM_TYPE_SIGMA,

DATA_PLATFORM_TYPE_DOMO,

DATA_PLATFORM_TYPE_MSSQL,

DATA_PLATFORM_TYPE_ORACLE,

DATA_PLATFORM_TYPE_ATHENA,

DATA_PLATFORM_TYPE_FABRIC,

DATA_PLATFORM_TYPE_SYNQ

filter.parts.inFolder.path

string[]

Opaque folder identifiers (a folder's own entity id). folders is the structured, human-authorable alternative. When path is the only source set and deep is unset, deep defaults to true for back-compat with queries authored before deep existed.

filter.parts.inFolder.folderOf.entityIds

string[]

Simplified source: the assets named directly by opaque entity id. Use this for the common "same folder as these specific assets" case; equivalent to an input_query that lists the same ids.

filter.parts.inFolder.folderOf.inputQuery.operand

enum<string>

Defaults to AND if not specified.

Available options:

QUERY_OPERAND_UNSPECIFIED,

QUERY_OPERAND_AND,

QUERY_OPERAND_OR,

QUERY_OPERAND_EXCEPT,

QUERY_OPERAND_UPSTREAM,

QUERY_OPERAND_DOWNSTREAM

filter.parts.inFolder.folderOf.includeAllAncestors

boolean

When false (default): only each asset's immediate parent folder. When true: every ancestor folder up the hierarchy, so InFolder then also matches assets in those ancestor folders.

filter.parts.inFolder.deep

boolean

When false or unset, matches only the direct members of the folder(s). When true, matches the entire recursive subtree (members of subfolders too).

Exception: when only the legacy path source is set and deep is unset, it defaults to true (preserves the behaviour of queries authored before this flag existed). With folders or folder_of, unset means false (shallow).

filter.parts.inDomain.domainId

string<uuid>

filter.parts.unsupported.queryJson

string

pagination.cursor

string

Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.

pagination.pageSize

integer<int32>

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0

Response

200 - application/json

Success

entityIds

string[]

Opaque entity ids of the folder's members.

pageInfo

PageInfo · object

Pagination cursor for the next page.

Show child attributes

GetFolderOf ListEntities

Get Started

Alerts

Monitors

Monitors Types

Data Products

Scout AI

Ownership

Incidents

Analytics

Lineage

BI Integrations

Data Warehouse Integrations

Transactional databases

Code Integrations

dbt Integrations

SQLMesh Integrations

Coalesce Integrations

Orchestration Tool Integrations

Alerting Integrations

Catalogs

Google Cloud Integrations

Admin

Security

Support

Developer API

ListMembers

Authorizations

Query Parameters

Response