---
title: "Get connection"
method: GET
path: "/api/v1/connections/{id}"
tags: ["Connections"]
---

# Get connection

`GET /api/v1/connections/{id}`

Fetch a single connection by ID, including its full non-secret configuration. Credentials (password, OAuth client secret, keypairs) are never returned.

## Path parameters

- `id` string, uuid, required — Connection ID

## Response `200`

Connection object

- object — Get connection response
  - `connection` object, required — Connection object
    - `acceptsLicense` boolean, nullable, required — Whether license terms have been accepted (Oracle)
    - `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.
    - `allowsUserSpecificTimezones` boolean, nullable, required — Whether users may specify their own timezones
    - `alwaysScopeViewNames` boolean, nullable, required — Whether generated view names always include catalog/schema scoping
    - `authenticationType` string, nullable, required — Authentication type. Dialect-specific; known values are `aws-access-key`, `aws-cross-account-role`, `databricks-oauth-m2m`, `databricks-personal-access-token`, `databricks-oauth-user`, `mssql-sql-authentication`, `mssql-active-directory-password`, `mssql-active-directory-service-principal`, `snowflake-oauth-user`, `snowflake-external-oauth-user`, `snowflake-password`, `snowflake-keypair`, `bigquery-oauth-user`, `bigquery-byo-oauth-user`, `bigquery-service-account`, `bigquery-workload-identity-federation`.
    - `awsRoleArn` string, nullable, required — AWS IAM role ARN (Athena)
    - `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/catalog name (project ID for BigQuery)
    - `defaultSchema` string, nullable, required — Default schema for the connection
    - `deletedAt` string, nullable, required — Timestamp when connection was archived (ISO 8601)
    - `dialect` 'bigquery' | 'mysql' | 'postgres' | 'redshift' | 'exasol' | 'snowflake' | 'motherduck' | 'mssql' | 'databricks' | 'databricks_lakebase' | 'clickhouse' | 'trino' | 'athena' | 'starrocks' | 'mariadb' | 'oracle' | 'sap_hana', required — Database dialect
    - `enableDbSemanticLayerIntegration` boolean, nullable, required — Whether the dialect-native semantic layer integration is enabled (Snowflake, Databricks)
    - `enableDbSemanticLayerTopics` boolean, nullable, required — Whether dialect-native semantic layer topics are generated (Snowflake, Databricks)
    - `environmentConnectionSwitchesSchemaModel` boolean, nullable, required — Whether environment connections switch schema model
    - `externalOauthAudience` string, nullable, required — External OAuth audience claim (Snowflake)
    - `externalOauthAuthorizationUrl` string, nullable, required — External OAuth authorization URL (Snowflake)
    - `externalOauthTokenUrl` string, nullable, required — External OAuth token URL (Snowflake)
    - `host` string, nullable, required — Hostname or IP of the database server (account identifier for Snowflake)
    - `hostOverride` string, nullable, required — Custom Snowflake host, overriding the account identifier
    - `id` string, uuid, required — Unique connection identifier
    - `includeOtherCatalogs` string[], nullable, required — Additional catalogs/databases included in schema refresh
    - `includeSchemas` string[], nullable, required — Schemas included in schema refresh. Null means all schemas are included.
    - `inferRelationshipsFromColumnNames` boolean, nullable, required — Whether relationships are inferred from column-name conventions during schema refresh
    - `inferRelationshipsFromForeignKeys` boolean, nullable, required — Whether relationships are inferred from declared foreign keys during schema refresh
    - `maxBillingBytes` string, nullable, required — Maximum bytes billed for a query, as a string (BigQuery). Null when unset.
    - `name` string, required — Connection display name
    - `oauthClientId` string, nullable, required — OAuth client ID for admin schema refresh (non-secret)
    - `offloadedSchemas` string[], nullable, required — Schemas queried via the offloaded engine
    - `port` integer, nullable, required — Port number for the database connection
    - `queryTimeoutSeconds` integer, nullable, required — Query timeout in seconds
    - `queryTimezone` string, nullable, required — Timezone used for query results
    - `region` string, nullable, required — Region (BigQuery, Athena)
    - `scratchSchema` string, nullable, required — Schema used for data input (upload) tables
    - `systemTimezone` string, nullable, required — Timezone of the database
    - `trustServerCertificate` boolean, nullable, required — Whether to trust the server certificate
    - `updatedAt` string, required — Timestamp when connection was last updated (ISO 8601)
    - `useMachineAuth` boolean, nullable, required — Whether machine (M2M OAuth) credentials are used
    - `useReadScaling` boolean, nullable, required — Whether read scaling is enabled (MotherDuck)
    - `useSessionHint` boolean, nullable, required — Whether session hints are applied (MotherDuck)
    - `userAttributeNameForConnectionEnvironments` string, nullable, required — User attribute name used for connection environments
    - `userAttributeValuesForDefaultEnvironment` string[], nullable, required — Default user attribute values for the base environment
    - `username` string, nullable, required — Username to authenticate with (client email for BigQuery service accounts)
    - `warehouse` string, nullable, required — Warehouse (Snowflake) or HTTP path (Databricks)

## Other responses

- `401` — Authentication required
- `403` — Permission denied — caller lacks READ on the connection
- `404` — Connection does not exist

---

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