connections

List connections

Changed on

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

Request

  • Base URL
    https://api.kater.ai
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

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

    • breaking

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

    • breaking

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

    • breaking

      added to the / response property oneOf list for the response status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      mapped value for discriminator key clickhouse changed from to for / response property for the response status

    • info

      mapped value for discriminator key mssql changed from to for / response property for the response status

    • info

      mapped value for discriminator key postgresql changed from to for / response property for the response status

    • info

      removed from the / response property oneOf list for the response status