Skip to main content
GET
/
v1
/
connections
/
{connectionId}
/
dbt
/
environments
List dbt environments
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/connections/{connectionId}/dbt/environments \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "247dc6dc-2a58-4688-9521-c5ed3e99c1e8",
    "name": "Production",
    "isDefaultEnvironment": true,
    "isDeferralEnabled": false,
    "ownerId": null,
    "targetDatabase": null,
    "targetName": null,
    "targetRole": null,
    "targetSchema": "public",
    "variables": []
  },
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Development",
    "isDefaultEnvironment": false,
    "isDeferralEnabled": true,
    "ownerId": "550e8400-e29b-41d4-a716-446655440000",
    "targetDatabase": "dev_analytics_db",
    "targetName": null,
    "targetRole": null,
    "targetSchema": "analytics_dev",
    "variables": [
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "name": "DBT_TARGET",
        "value": "dev",
        "isSecret": false
      },
      {
        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "name": "DBT_API_KEY",
        "value": null,
        "isSecret": true
      }
    ]
  }
]

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

The unique identifier of the connection

Response

List of dbt environments retrieved successfully

​
id
string<uuid>

Unique identifier of the dbt environment

​
name
string

The name of the dbt environment

​
isDefaultEnvironment
boolean

Whether this is the default environment

​
isDeferralEnabled
boolean

Whether deferral is enabled for this environment. Ignored (forced to false) for the default (production) environment.

​
ownerId
string<uuid> | null

The user ID of the owner of the dbt environment, or null

​
targetDatabase
string | null

Target database override

​
targetName
string | null

Target name override

​
targetRole
string | null

Target role override

​
targetSchema
string

Target schema for the environment

​
variables
object[]

Environment variables