---
title: "List connections"
method: GET
path: "/v1/connections"
tags: ["Connections"]
---

# List connections

`GET /v1/connections`

Retrieves a list of database connections with optional filtering and sorting

## Query parameters

- `name` string
- `database` string
- `dialect` 'athena' | 'bigquery' | 'clickhouse' | 'databricks' | 'databricks_lakebase' | 'exasol' | 'mariadb' | 'motherduck' | 'mssql' | 'mysql' | 'oracle' | 'postgres' | 'redshift' | 'sap_hana' | 'snowflake' | 'starrocks' | 'trino' — The database dialect.
- `sortField` 'database' | 'dialect' | 'name'
- `sortDirection` 'asc' | 'desc'
- `includeDeleted` boolean

## Response `200`

Returns a list of connections objects

- object
  - `connections` Connection[]
    - `id` string, uuid — The connection's unique ID
    - `name` string — A descriptive name for the connection
    - `dialect` string — The type of database
    - `database` string — The default database/catalog to connect to.
    - `baseRole` string — The default role for users accessing the connection.
    - `createdAt` string, date-time — The time the connection was created.
    - `updatedAt` string, date-time — The time the connection was last updated.
    - `deletedAt` string, date-time — The time the database was deleted.
    - `userAttributeNameForConnectionEnvironments` string
    - `userAttributeValuesForDefaultEnvironment` string
    - `branchConnectionEnvironmentOverridesUserAttr` boolean
    - `environmentConnectionSwitchesSchemaModel` boolean
    - `defaultSchema` string — The default schema to use.

## Other responses

- `400` — Bad Request Possible error messages: - `formErrors: Unrecognized key(s) in object: '<invalidParam>'` - `sortField: Invalid enum value. Expected 'database' | 'dialect' | 'name', received '<invalidField>'` - `Invalid dialect(s): <invalidDialect>`
- `429` — Too Many Requests - Rate limit exceeded (60 requests/minute)

---

[API](https://skmtc.net/omni/apis/omni-api.md) · [All operations](https://skmtc.net/omni/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omni/omni-api/revisions/6b02f7349d0e/schema)