List connected accounts

GET/api/v1/connected_accounts

Lists the connected accounts in the environment, filtered by connection, identifier, provider or organization, with each account's status. The list doesn't include credentials; use Get a connected account's credentials for one account. Use next_page_token to get the next page.

This page as markdown Connected accounts overview

Authorization

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

Query parameters

connection_namesarray of string

Filter by one or more connection names (exact match). Returns connected accounts belonging to any of the specified connections. Max 20 names per request. Cannot be combined with the connector field.

connectorstring

The connection name, as shown in AgentKit > Connections.

identifierstring

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

is_org_wide_credentialboolean

Set to true to return only the shared credential of an org-wide connection, or false to return only users' own accounts. Omit it to return both.

organization_idstring

Filter by organization ID. Returns only connected accounts associated with this organization.

page_sizeinteger

Maximum number of connected accounts to return, up to 99. Defaults to 10 when omitted or 0.

page_tokenstring

Pagination token from a previous response. Use the next_page_token value from ListConnectedAccountsResponse to fetch the next page.

providerstring

Return only accounts for this app, such as GMAIL or SLACK. Exact match, in capitals as the account's provider shows it.

querystring

Text search query to filter connected accounts by name, identifier, or other searchable fields. Case-insensitive.

user_idstring

Filter by user ID. Returns only connected accounts associated with this user.

scalekit_client.actions.list_connected_accounts

List connected accounts with optional filtering.

scalekit_client.actions.list_connected_accounts(
    connection_name: Optional[str] = None,
    identifier: Optional[str] = None,
    provider: Optional[str] = None,
    connection_names: Optional[List[str]] = None,
    page_size: Optional[int] = None,
    page_token: Optional[str] = None,
    query: Optional[str] = None,
    is_org_wide_credential: Optional[bool] = None,
) -> ListConnectedAccountsResponse

Parameters

connection_nameOptional[str]

The connection name, as shown in AgentKit > Connections.

identifierOptional[str]

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

providerOptional[str]

Return only accounts for this app, such as GMAIL or SLACK. Exact match, in capitals as the account's provider shows it.

connection_namesOptional[List[str]]

Connection names, exact match. Returns accounts on any of them, such as ["gmail", "github-connect"]. Combine with identifier for one user.

page_sizeOptional[int]

Maximum number of connected accounts per page

page_tokenOptional[str]

next_page_token from a previous response, to fetch the next page

queryOptional[str]

Text to search for (optional, up to 100 characters). Matches anywhere in the account identifier, the provider, the connection name and the provider's display name, ignoring case. When query is given, only connection_name (and the paging options) narrow the search; identifier, provider, connection_names and is_org_wide_credential are not applied, so use those without query.

is_org_wide_credentialOptional[bool]

For connections that share one credential across the organization: True returns only the account that holds that shared credential, False returns only the per-user accounts. Leave as None to return both

Returns ListConnectedAccountsResponse: The matching connected accounts, with next_page_token set when more pages remain.

From scalekit-sdk-python 2.25.0.

scalekit.actions.listConnectedAccounts

List connected accounts with optional filters.

scalekit.actions.listConnectedAccounts(
  params?: {
    connectionName?: string;
    identifier?: string;
    provider?: string;
    organizationId?: string;
    userId?: string;
    pageSize?: number;
    pageToken?: string;
    query?: string;
    connectionNames?: string[];
    isOrgWideCredential?: boolean;
  },
): Promise<ListConnectedAccountsResponse>

Parameters

connectionNamestring

The connection name, as shown in AgentKit > Connections.

identifierstring

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

providerstring

Return only accounts for this app, such as GMAIL or SLACK. Exact match, in capitals as the account's provider shows it.

organizationIdstring

Filter by organization ID. Returns only connected accounts associated with this organization.

userIdstring

Filter by user ID. Returns only connected accounts associated with this user.

pageSizenumber

Maximum number of connected accounts to return, up to 99. Defaults to 10 when omitted or 0.

pageTokenstring

Pagination token from a previous response. Use the next_page_token value from ListConnectedAccountsResponse to fetch the next page.

querystring

Text to search for (up to 100 characters), ignoring case. With query, only connectionName and the paging options narrow the search; identifier, provider, connectionNames and isOrgWideCredential are not applied, so use those without it.

connectionNamesstring[]

isOrgWideCredentialboolean

For connections that share one credential across the organization: true returns only the account that holds that shared credential, false returns only the per-user accounts. Leave it out to get both.

Returns Promise<ListConnectedAccountsResponse>.

From @scalekit-sdk/node 2.22.0.

Response 200

connected_accountsarray of object

List of connected accounts matching the filter criteria. Excludes sensitive authorization details for security.

Show 11 child attributes

authorization_typestring (enum)

Authorization mechanism type.

OAUTHAPI_KEYBASIC_AUTHBEARER_TOKENCUSTOMBASICOAUTH_M2MTRELLO_OAUTH1GOOGLE_DWDTRUSTED_IDPSMART_FHIRNO_AUTH

connection_idstring

Parent connection configuration reference.

connectorstring

The connection name, as shown in AgentKit > Connections.

idstring

Unique connected account identifier.

identifierstring

Your app's ID for the user, the value passed when the account was created.

is_org_wide_credentialboolean

Whether this is the shared credential of an org-wide connection, which every user's tool calls on that connection use. false for a user's own account.

last_used_atstring

Last usage timestamp.

providerstring

The app the account connects to, such as GMAIL or SLACK.

statusstring (enum)

Current connection status.

ACTIVEEXPIREDPENDING_AUTHPENDING_VERIFICATIONDISCONNECTED

token_expires_atstring

Token expiration timestamp.

updated_atstring

Last modification timestamp.

next_page_tokenstring

Pagination token for retrieving the next page. Empty if this is the last page. Pass this value to page_token in the next request.

prev_page_tokenstring

Pagination token for retrieving the previous page. Empty if this is the first page. Pass this value to page_token to go back.

total_sizeinteger

Total count of connected accounts matching the filter criteria across all pages. Use for calculating pagination.

Errors

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

400Invalid request - occurs when query parameters are malformed or validation fails

401Authentication required - missing or invalid access token

Used in

Manage connected accounts

Request

curl -sS -G -X GET \
  "$SCALEKIT_ENVIRONMENT_URL/api/v1/connected_accounts" \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "connector=gmail" \
  --data-urlencode "identifier=user_123"

result = scalekit_client.actions.list_connected_accounts(
    connection_name="gmail",
    identifier="user_123",
)

const result = await scalekit.actions.listConnectedAccounts({
  connectionName: "gmail",
  identifier: "user_123",
});

Response 200

1
{
2
  "connected_accounts": [
3
    {
4
      "id": "ca_24834495392086178",
5
      "connection_id": "conn_70219645518265104",
6
      "connector": "gmail",
7
      "identifier": "user_123",
8
      "provider": "GMAIL",
9
      "authorization_type": "OAUTH",
10
      "status": "ACTIVE",
11
      "is_org_wide_credential": false,
12
      "token_expires_at": "2026-10-02T15:30:00Z",
13
      "last_used_at": "2026-10-02T14:31:07Z",
14
      "updated_at": "2026-10-02T14:30:00Z"
15
    }
16
  ],
17
  "next_page_token": "",
18
  "prev_page_token": "",
19
  "total_size": 1
20
}