Sign in

v35

latestOpenAPI 3.1.0raw.githubusercontent.com2025-09-2241237309.7 KB

List Connections

List all connections with optional filtering. Does not retrieve secrets or perform any connection healthcheck. For that use getConnection or checkConnectionHealth.

get/v1/connection

Query parameters

limitinteger

Limit the number of items returned

Limit the number of items returned

offsetinteger

Offset the items returned

Offset the items returned

connector_namesCoreConnectorName[]
customer_idstring

The id of the customer in your application. Ensure it is unique for that customer.

The id of the customer in your application. Ensure it is unique for that customer.

connector_config_idstring

The id of the connector config, starts with ccfg_

The id of the connector config, starts with ccfg_

include_secretsboolean
expandstring[]

Expand the response with additional optionals

search_querystring
refresh_policy'none' | 'force' | 'auto'

Controls credential refresh: none (never), force (always), or auto (when expired, default)

Controls credential refresh: none (never), force (always), or auto (when expired, default)

Response

Successful response

totalinteger required

Total number of items in the database for the organization

limitinteger required

Limit the number of items returned

offsetinteger required

Offset the items returned

has_next_pageboolean

Convenience flag = offset + limit >= total