Skip to main content
GET
List connections

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Query Parameters

name
string

Filter connections by name (case-insensitive, partial matching)

database
string

Filter connections by database name (case-insensitive, partial matching)

dialect
string

Filter connections by dialect(s). For multiple dialects, provide a comma-separated list (e.g., postgres,mysql).

Pattern: ^(?:\s*(bigquery|mysql|postgres|redshift|exasol|snowflake|motherduck|mssql|fabric|databricks|databricks_lakebase|clickhouse|trino|athena|starrocks|mariadb|oracle|sap_hana)\s*(?:,\s*(bigquery|mysql|postgres|redshift|exasol|snowflake|motherduck|mssql|fabric|databricks|databricks_lakebase|clickhouse|trino|athena|starrocks|mariadb|oracle|sap_hana)\s*)*)?$
sortField
enum<string>

Field to sort by

Available options:
database,
dialect,
name
sortDirection
enum<string>

Direction for sorting results:

  • asc - Ascending order (A-Z, 0-9)
  • desc - Descending order (Z-A, 9-0)
Available options:
asc,
desc
includeDeleted
boolean

When true, the response includes deleted connections. Defaults to false.

Response

Returns a list of connections objects

connections
object[]