Skip to main content
GET
/
v1
/
connections
/
{connectionId}
Get connection
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/connections/{connectionId} \
  --header 'Authorization: Bearer <token>'
{
  "connection": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Production Snowflake",
    "dialect": "snowflake",
    "database": "analytics_db",
    "defaultSchema": "public",
    "deletedAt": null,
    "baseRole": "QUERIER",
    "branchConnectionEnvironmentOverridesUserAttr": false,
    "environmentConnectionSwitchesSchemaModel": false,
    "userAttributeNameForConnectionEnvironments": null,
    "userAttributeValuesForDefaultEnvironment": null
  }
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
connectionId
string<uuid>
required

Connection ID

Response

Connection retrieved successfully

​
connection
object