Sign in
connections

List connections

List warehouse connections for the client.

Filter connections by approval status using the status query parameter:

  • approved (default): Only approved connections (is_pending_approval=false)
  • pending: Only connections awaiting PR approval (is_pending_approval=true)
  • all: All connections regardless of approval status

Pending connections include their approval PR URLs when available. Returns empty list if GitHub is not configured.

RLS: Filtered to current client (DualClientRLSDB).

get/api/v1/connections

Query parameters

status'approved' | 'pending' | 'all'

Response

Successful Response

approval_pr_urlstring nullable

GitHub PR URL for approving the connection (None if already approved)

created_atstring date-time required

Creation timestamp

credential_idstring uuid required

Credential ID

descriptionstring nullable

Connection description

idstring uuid required

Connection ID

is_pending_approvalboolean

True if this connection is awaiting PR approval

labelstring nullable

Human-readable label

namestring required

Connection name

query_timeoutinteger nullable

Query timeout in seconds

query_timezone_conversionstring nullable

Timezone conversion mode (do_not_convert, convert_to_utc)

updated_atstring date-time required

Last update timestamp

warehouse_typestring required

Warehouse type (snowflake, postgresql, etc.)

Changes

Changed in 4 of the 11 revisions of this API.10916

  • bef1f3e205dd2See the full diff
    • ▲

      response property errors list-of-types was widened by adding types array to media type application/json of response 401

      response-property-list-of-types-widened

    • ▲

      response property errors list-of-types was widened by adding types array to media type application/json of response 422

      response-property-list-of-types-widened

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 91ea1d9f6c07128See the full diff
    • ▲

      added PostgresqlMetadata ClickhouseMetadata MssqlMetadata to the items/warehouse_metadata response property oneOf list for the response status 200

      response-property-one-of-added

    • ●

      removed the optional property items/database_timezone from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/sync_id from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter status

      new-optional-request-parameter

    • ○

      added the non-success response with the status 422

      response-non-success-status-added

    • ○

      added the optional property items/approval_pr_url to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/is_pending_approval to the response with the 200 status

      response-optional-property-added

    • ○

      mapped value for discriminator key clickhouse changed from ClickHouseMetadata to ClickhouseMetadata for items/warehouse_metadata response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key mssql changed from MSSQLMetadata to MssqlMetadata for items/warehouse_metadata response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key postgresql changed from PostgresMetadata to PostgresqlMetadata for items/warehouse_metadata response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      removed PostgresMetadata ClickHouseMetadata MSSQLMetadata from the items/warehouse_metadata response property oneOf list for the response status 200

      response-property-one-of-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d2a2a2d0775e2See the full diff
    • ○

      added the required property items/databases/items/database_object_name to the response with the 200 status

      response-required-property-added

    • ○

      added the required property items/databases/items/schemas/items/database_object_name to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5f4f08ff6556776See the full diff
    • ▲

      the response property items/databases/items/description became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/databases/items/label became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/databases/items/schemas/items/description became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/databases/items/schemas/items/label became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/databases/items/timezone became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/description became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/label became optional for the status 200

      response-property-became-optional

    • ●

      removed the optional property items/account from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/host from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/http_path from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/port from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/role from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/server_hostname from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/warehouse from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property items/database_timezone to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/query_timeout to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/query_timezone_conversion to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/sync_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property items/warehouse_metadata to the response with the 200 status

      response-required-property-added

    • ○

      added the required property items/warehouse_type to the response with the 200 status

      response-required-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog