List connections

GET/api/v1/agentkit/connection

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.

This page as markdown Connections overview

Authorization

Authorization: Bearer $TOKEN, an access token from the client credentials grant. See Authentication.

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.

scalekit_client.actions.list_app_connections

Lists connections, newest first. Filter by connector with provider, or search by name with query.

scalekit_client.actions.list_app_connections(
    provider: Optional[str] = None,
    query: Optional[str] = None,
    page_size: Optional[int] = None,
    page_token: Optional[str] = None,
) -> AgentKitConnectionList

Parameters

providerOptional[str]

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

queryOptional[str]

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

page_sizeOptional[int]

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

page_tokenOptional[str]

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

Returns AgentKitConnectionList.

From scalekit-sdk-python 2.22.0.

scalekit.actions.listAppConnections

Lists connections, newest first. Filter by connector with provider, or search by name with query.

scalekit.actions.listAppConnections(
  params?: {
    provider?: string;
    query?: string;
    pageSize?: number;
    pageToken?: string;
  },
): Promise<ListAppConnectionsResponse>

Parameters

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.

pageSizenumber

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

pageTokenstring

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

Returns Promise<ListAppConnectionsResponse>.

From @scalekit-sdk/node 2.21.0.

Response 200

connectionsarray of object

The connections on this page, newest first.

Show 6 child attributes

auth_modestring (enum)

USER: each user authorizes their own account. ORG_WIDE: one admin-authorized account is shared.

USERORG_WIDE

connection_namestring

The connection's name.

create_timestring

When the connection was created.

idstring

The connection's ID.

providerstring

The connector this connection uses, such as GMAIL.

typestring (enum)

How users authenticate to the app, such as OAUTH.

OIDCSAMLPASSWORDOAUTHPASSWORDLESSBASICBEARERAPI_KEYWEBAUTHNOAUTH_M2MTRELLO_OAUTH1GOOGLE_DWDTRUSTED_IDPSMART_FHIRNO_AUTH

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.

Errors

Every error has the same body: code, message and details. See Errors and rate limits.

400Invalid request - for example, query is shorter than 3 characters.

401Authentication required - missing or invalid access token

Request

curl -sS -G -X GET \
  "$SCALEKIT_ENVIRONMENT_URL/api/v1/agentkit/connection" \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "provider=GMAIL" \
  --data-urlencode "page_size=10"

result = scalekit_client.actions.list_app_connections(
    provider="GMAIL",
    page_size=10,
)

const result = await scalekit.actions.listAppConnections({
  provider: "GMAIL",
  pageSize: 10,
});

Response 200

1
{
2
  "connections": [
3
    {
4
      "id": "conn_70219645518265104",
5
      "connection_name": "gmail-work",
6
      "provider": "GMAIL",
7
      "type": "OAUTH",
8
      "auth_mode": "USER",
9
      "create_time": "2026-10-02T14:30:00Z"
10
    },
11
    {
12
      "id": "conn_70219645518265377",
13
      "connection_name": "gmail-support",
14
      "provider": "GMAIL",
15
      "type": "OAUTH",
16
      "auth_mode": "USER",
17
      "create_time": "2026-09-28T09:12:00Z"
18
    }
19
  ],
20
  "next_page_token": "",
21
  "prev_page_token": "",
22
  "total_size": 2
23
}