get all connections

Prerequisites

• The caller does not have to provide anything.

Authorization

• API key (via the X-API-KEY header).

Parameters

<Accordion title="Query Parameters"> | Field name | Description | Format | | :-------------- | :-------------------------------------- | :------ | | usage | Include usage count for each connection | Boolean | | offset | Number of items to skip for pagination | Integer | | limit | Maximum number of items to return | Integer | | connector\_name | Filter connections by connector type | String | | sort | Sort order for results. | String | </Accordion>

<Accordion title="Response Body"> | Field name | Description | Format | | :--------- | :------------------------------------------- | :------ | | elements | [List of connections](#connection-structure) | Array | | total | Total amount of connections | Integer | </Accordion>

<Accordion title="Connection Structure"> <div id="connection-structure"> | Field name | Description | Format | | :---------- | :---------------------------------------- | :------ | | id | Connection ID | UUID | | name | The name of the connection | String | | connector | The type of connector | String | | description | Connection description | String | | profiles | [Connection profiles](#profile-structure) | Map | | modifiedAt | The date and time of modification | String | | modifiedBy | Modified by | String | | createdAt | The date and time of creation | String | | createdBy | Created by | String | | usage | Number of times the connection is used | Integer | </div> </Accordion>

<Accordion title="Profile Structure"> <div id="profile-structure"> | Field name | Description | Format | | :----------- | :------------- | :---------- | | profileName | Key | String | | profileValue | Profile config | JsonElement | </div> </Accordion>

Examples

<Tabs> <Tab title="mainframe-rpc"> ```json Response { "elements": [ { "id": "00000000-0000-0000-0000-000000000001", "name": "connection-mf-cics-cobol", "connector": "mainFrameRpc", "description": "example mf-cics-cobol connection", "profiles": { "$default": { "baseUrl": "http://cics.example.internal", "uriMap": "/example/latest", "port": "12345", "codePage": "cp037" } }, "modifiedAt": "2026-01-01T00:00:00.000000Z", "modifiedBy": "John Doe", "createdAt": "2026-01-01T00:00:00.000000Z", "createdBy": "John Doe", "usage": 0 } ], "total": 1 } ``` </Tab>

<Tab /> </Tabs>