Skip to main content
POST
ListRelationships

Authorizations

Authorization
string
header
required

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

Body

application/json
ids
(airflow_dag · object | airflow_task · object | athena_table · object | bigquery_table · object | clickhouse_table · object | custom · object | databricks_table · object | dataproduct · object | dbt_cloud_node · object | dbt_core_node · object | fabric_table · object | monitor · object | mssql_table · object | mysql_table · object | oracle_table · object | postgres_table · object | redshift_table · object | saved_view · object | snowflake_table · object | sql_mesh_audit · object | sql_mesh_model · object | synq_path · object | trino_table · object)[]

Return relationships for the given entity_id. Either upstream or downstream. Leave empty to return every relationship in the workspace: an edge hangs off endpoints a caller may not know up front, so enumerating them by id requires already knowing every entity an edge can touch.

Identifier is a unique reference to an entity in Coalesce Quality system. Entity identifiers are designed to closely mimic identifiers used by data platforms and tools. To construct an identifier, you need to know the kind of the entity and the ids that you would normally use to identify it in the data platform or tool. For example, to identify a table in BigQuery, you would need to know the project, dataset, and table names.

pagination
Pagination · object | null

Pagination. Omitting this, or sending a zero page_size, returns every matching relationship in one response — there is no server-side default page size. Set page_size to bound the response; pass page_info.last_id from the previous response as the cursor to fetch the next page.

Response

200 - application/json

Success

relationships
Relationship · object[]
pageInfo
PageInfo · object

Paging information for this response. Always populated. Repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty to walk the whole result set.