---
title: "Get connection details"
method: GET
path: "/v2/connections/{connectionId}"
tags: ["Connections"]
---

# Get connection details

`GET /v2/connections/{connectionId}`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/connections/{connectionId}`
- Auth: HTTP bearer

Get the metadata of a specific connection by connection ID.

### Usage notes
- Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.

## Path parameters

- `connectionId` string, required

## Response `200`

The response body.

- ConnectionsGetConnectionResponse200
  - `organizationId` string, required: Unique identifier of the organization
  - `connectionId` string, required: Unique identifier of the connection
  - `isSample` boolean, required: Whether the connection is the Sigma sample data connection
  - `isAuditLog` boolean, required: Whether audit logging is enabled
  - `lastActiveAt` string, date-time, required: Last activity date and time
  - `name` string, required: Name of the connection
  - `type` string, required: Type of the connection (e.g., "bigQuery")
  - `useOauth` boolean, required: Whether OAuth is used
  - `createdBy` string, required: Identifier of the user who created this connection
  - `updatedBy` string, required: Identifier of the user or process that last updated this connection
  - `createdAt` string, date-time, required: When the connection was created
  - `updatedAt` string, date-time, required: When the connection was last updated
  - `isArchived` boolean: Whether the connection is archived
  - `account` string: Account associated with the connection
  - `warehouse` string: Warehouse associated with the connection
  - `user` string: User associated with the connection
  - `httpPath` string: For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path.
  - `role` string: Role used by the connection user
  - `timeout` V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaTimeout: Timeout settings for the connection, with a default value in seconds
    - `default` number, double, required
    - `worksheet` number, double
    - `dashboard` number, double
    - `download` number, double
  - `poolSizes` V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaPoolSizes: Pool sizes for the connection, such as for catalogPoolSize or schedulePoolSize
    - `isPoolConfigured` boolean
    - `catalogPoolSize` number, double
    - `resultPoolSize` number, double
    - `schedulePoolSize` number, double
  - `writeAccess` boolean
  - `friendlyName` boolean: Whether friendly names are enabled for this connection
  - `writebacks` V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaWritebacksItems[]: Configure write-back for non-OAuth connections
    - `database` string, required: Database, catalog, or top-level object to contain tables written back to the data platform
    - `schema` string, required: Schema, database, or second-level object to contain tables written back to the data platform
    - `writebackSchemaId` string: Unique identifier of the writebackSchema
    - `description` string: Description for the write-back destination.
  - `writebackSchemas` V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaWritebackSchemasItems[]: Configure write-back for OAuth connections
    - `database` string, required: Database, catalog, or top-level object to contain tables written back to the data platform
    - `schema` string, required: Schema, database, or second-level object to contain tables written back to the data platform
    - `writebackSchemaId` string: Unique identifier of the writebackSchema
    - `description` string: Description for the write-back destination.
  - `inputTableAuditLogSchema` V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaInputTableAuditLogSchema: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.
    - `database` string, required: Database, catalog, or top-level object to contain tables written back to the data platform
    - `schema` string, required: Schema, database, or second-level object to contain tables written back to the data platform
    - `writebackSchemaId` string: Unique identifier of the writebackSchema
  - `materializationWarehouse` string: Warehouse used to run materialization jobs
  - `exportsWarehouse` string: Warehouse used to run export jobs
  - `oauthMetadataUrl` string: OAuth metadata URL configured directly on this connection.
  - `oauthClientId` string: Client ID configured directly on this connection.
  - `oauthScopes` string[]: OAuth scopes configured directly on this connection.
  - `oauthIdpType` union: OAuth provider type configured or inferred for this connection.
    - 'aws_databricks'
    - 'azure_databricks'
    - 'gcp_databricks'
    - 'azuread'
    - 'auth0'
    - 'adfs'
    - 'okta'
    - 'ping'
    - 'snowflake'
    - 'unknown'
  - `oauthUsePkce` boolean, nullable: Whether this connection-level OAuth configuration uses PKCE.
  - `oauthUseJwt` boolean, nullable: Whether this connection-level OAuth configuration uses JWT bearer token authentication.
  - `oauthJwkSetId` string: Unique identifier of the JWK set used to sign JWT bearer assertions for this connection.
  - `oauthAudience` string: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery.
  - `isIndependentOAuth` boolean: Whether this connection uses connection-level OAuth instead of organization-level OAuth.
  - `userAttributes` V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaUserAttributes: User attributes associated with the connection
    - `role` string
    - `warehouse` string
  - `roleSwitching` 'allRoles' | 'disabled': Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only relevant for Snowflake OAuth connections.
  - `enableHiveMetastore` boolean: Whether this Databricks connection exposes the `hive_metastore` catalog in Sigma. Only relevant for Databricks connections.
  - `usePython` boolean
  - `pythonComputeClusterId` string: ID of the all-purpose compute cluster used to run Python queries. Only relevant for Databricks connections with Python enabled.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)