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

# List connections

`GET /api/v1/connections`

## Query parameters

- `database` string — Filter by database name (case-insensitive contains)
- `dialect` string — Filter by dialect(s). Comma-separated list for multiple values
- `includeDeleted` boolean — Include soft-deleted connections in results
- `name` string — Filter by connection name (case-insensitive contains)
- `sortDirection` 'asc' | 'desc' — Sort direction
- `sortField` 'database' | 'dialect' | 'name' — Field to sort by

## Response `200`

List of connections

- object — List connections response
  - `connections` object[], required — List of connections
    - `allowBranchConnectionEnvironments` boolean, nullable, required — Whether a branch may select its own connection environment. When user-attribute environment selection is also enabled, a branch selection overrides the user attribute.
    - `baseRole` string, nullable, required — Default role for users on this connection
    - `branchConnectionEnvironmentOverridesUserAttr` boolean, nullable, required — Deprecated alias for `allowBranchConnectionEnvironments`; same value. Use `allowBranchConnectionEnvironments` instead.
    - `createdAt` string, required — Timestamp when connection was created (ISO 8601)
    - `database` string, nullable, required — Database name
    - `defaultSchema` string, nullable, required — Default schema for the connection
    - `deletedAt` string, nullable, required — Timestamp when connection was deleted (ISO 8601)
    - `dialect` 'snowflake' | 'bigquery' | 'redshift' | 'postgres' | 'mysql' | 'mariadb' | 'databricks' | 'databricks_lakebase' | 'trino' | 'athena' | 'duckdb' | 'motherduck' | 'sqlserver' | 'clickhouse' | 'singlestore', required — Database dialect type
    - `environmentConnectionSwitchesSchemaModel` boolean, nullable, required — Whether environment connections switch schema model
    - `id` string, uuid, required — Unique connection identifier
    - `name` string, required — Connection display name
    - `updatedAt` string, required — Timestamp when connection was last updated (ISO 8601)
    - `userAttributeNameForConnectionEnvironments` string, nullable, required — User attribute name used for connection environments
    - `userAttributeValuesForDefaultEnvironment` string[], nullable, required — Default user attribute values for the base environment

## Other responses

- `401` — Authentication required
- `403` — Permission denied - admin role required

---

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