Sign in
latestOpenAPI 3.1.02026-08-2284340459.3 KB

cd4c91e0e6c2

Connections
MCP

Get Connections

Authorization scope: connection:list

Get all connection entities as a paginated list

📖 Instructions for usage

list_connections

List all connections in an environment (sweeps every page in one call).

Returns {items, total_items, page, has_next}. Each item includes connection_name,
connection_type, connection_type_id, and cross_id; use cross_id as connection_id
when creating data flows. If the upstream 500s on a specific page, that page is
skipped and its number is reported under "incomplete_pages" rather than failing
the whole listing.
get/v1/accounts/{account_id}/environments/{environment_id}/connections

Path parameters

account_idstring required
environment_idstring required

Query parameters

items_per_pageinteger

The number of items per page in the paginated list.

The number of items per page in the paginated list.

pageinteger

The current page number in the paginated list.

The current page number in the paginated list.

Response

Successful Response

next_pagestring nullable

The next page URL

previous_pagestring nullable

The previous page URL

pageinteger

The page number

current_page_sizeinteger required

The current page size

total_itemsinteger

The total number of entities fetched

account_idstring required

The account id

environment_idstring required

The environment id

Example response

{
  "items": [
    {
      "cross_id": "5f887c764c40e5598f717676",
      "_id": "5f887c764c40e5598f717676",
      "connection_name": "test connection",
      "connection_type": "Oracle",
      "connection_type_id": "oracle",
      "connection_update_by": "5f887c764c40e5598f717676"
    }
  ]
}