Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Connections

List connections

Retrieves a list of database connections with optional filtering and sorting

get/v1/connections

Query parameters

namestring

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

databasestring

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

dialect'athena' | 'bigquery' | 'clickhouse' | 'databricks' | 'databricks_lakebase' | 'exasol' | 'mariadb' | 'motherduck' | 'mssql' | 'mysql' | 'oracle' | 'postgres' | 'redshift' | 'sap_hana' | 'snowflake' | 'starrocks' | 'trino'

The database dialect.

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

sortField'database' | 'dialect' | 'name'

Field to sort by

sortDirection'asc' | 'desc'

Direction for sorting:

  • asc - Ascending order (A-Z, 0-9)
  • desc - Descending order (Z-A, 9-0)
includeDeletedboolean

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

Response

Returns a list of connections objects

Example response

{
  "connections": [
    {
      "id": "c0f12353-4817-4398-bcc0-d501e6dd2f64",
      "name": "Production Database",
      "dialect": "postgres",
      "database": "prod_db",
      "baseRole": "NO_ACCESS",
      "createdAt": "2026-06-01T14:30:00.000Z",
      "updatedAt": "2026-06-11T10:15:30.000Z",
      "userAttributeNameForConnectionEnvironments": "environment",
      "defaultSchema": "public"
    }
  ]
}