SCscalekit
App Connections

List connections

Changed on

Lists the connections in the environment, newest first, without their settings. Filter by connector, or search by name. Use it to find a connection's name or ID, or to check whether a connector already has a connection; call Get a connection for one connection's settings.

get/api/v1/agentkit/connection

Request

Query parameters

page_sizeinteger

The number of connections to return, up to 100. Defaults to 10.

page_tokenstring

The next_page_token from the previous response, to get the next page. Leave it out for the first page.

providerstring

Return only connections for this connector, by its identifier, such as GMAIL. A connection's provider field holds the same value.

querystring

Return connections whose name, connector or connector display name contains this text, such as gmail. At least 3 characters.

Response

The connections on this page, with the token for the next page.

next_page_tokenstring

Pass as page_token to get the next page. Empty on the last page.

prev_page_tokenstring

Pass as page_token to get the previous page.

total_sizeinteger

The number of connections that match.

Example response

{
  "connections": [
    {
      "id": "conn_2123312131125533"
    }
  ]
}

Changes