List 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.
Authorization
Authorization: Bearer $TOKEN, an access token from the client credentials grant. See Authentication.
Query parameters
connection_namesarray of stringFilter 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.connectorstringThe connection name, as shown in AgentKit > Connections.
identifierstringYour 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_credentialbooleanSet 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_idstringFilter by organization ID. Returns only connected accounts associated with this organization.
page_sizeintegerMaximum number of connected accounts to return, up to 99. Defaults to 10 when omitted or 0.
page_tokenstringPagination token from a previous response. Use the next_page_token value from ListConnectedAccountsResponse to fetch the next page.
providerstringReturn only accounts for this app, such as
GMAIL or SLACK. Exact match, in capitals as the account's provider shows it.querystringText search query to filter connected accounts by name, identifier, or other searchable fields. Case-insensitive.
user_idstringFilter 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,) -> ListConnectedAccountsResponseParameters
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.Returns ListConnectedAccountsResponse: The matching connected accounts.
From scalekit-sdk-python 2.19.1.
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[]; },): Promise<ListConnectedAccountsResponse>Parameters
connectionNamestringThe connection name, as shown in AgentKit > Connections.
identifierstringYour app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.
providerstringReturn only accounts for this app, such as
GMAIL or SLACK. Exact match, in capitals as the account's provider shows it.organizationIdstringFilter by organization ID. Returns only connected accounts associated with this organization.
userIdstringFilter by user ID. Returns only connected accounts associated with this user.
pageSizenumberMaximum number of connected accounts to return, up to 99. Defaults to 10 when omitted or 0.
pageTokenstringPagination token from a previous response. Use the next_page_token value from ListConnectedAccountsResponse to fetch the next page.
querystringText search query to filter connected accounts by name, identifier, or other searchable fields. Case-insensitive.
connectionNamesstring[]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.Returns Promise<ListConnectedAccountsResponse>.
From @scalekit-sdk/node 2.18.0.
Response 200
connected_accountsarray of objectList 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_AUTHconnection_idstringParent connection configuration reference.
connectorstringThe connection name, as shown in AgentKit > Connections.
idstringUnique connected account identifier.
identifierstringYour app's ID for the user, the value passed when the account was created.
is_org_wide_credentialbooleanWhether 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_atstringLast usage timestamp.
providerstringThe app the account connects to, such as
GMAIL or SLACK.statusstring (enum)Current connection status.
ACTIVEEXPIREDPENDING_AUTHPENDING_VERIFICATIONDISCONNECTEDtoken_expires_atstringToken expiration timestamp.
updated_atstringLast modification timestamp.
next_page_tokenstringPagination 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_tokenstringPagination token for retrieving the previous page. Empty if this is the first page. Pass this value to page_token to go back.
total_sizeintegerTotal 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 fails401Authentication required - missing or invalid access token