Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Search connected accounts

GET/api/v1/connected_accounts:search

Search for connected accounts in your environment using a text query that matches against identifiers, providers, or connectors. The search performs case-insensitive matching across account details. Returns paginated results with account status and authentication type information.

This page as markdownConnected accounts overview

Authorization

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

Query parameters

querystringrequired
Search term to match against connected account identifiers, providers, or connectors. Must be at least 3 characters. Case insensitive.
connection_idstring
Connection ID to filter connected accounts
page_sizeinteger
Maximum number of connected accounts to return per page. Value must be between 1 and 30.
page_tokenstring
Token from a previous response for pagination. Provide this to retrieve the next page of results.

Response 200

connected_accountsarray of object
List of connected accounts matching the search query. Excludes sensitive authorization details.
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 the next page. Empty if this is the last page.
prev_page_tokenstring
Pagination token for the previous page. Empty if this is the first page.
total_sizeinteger
Total count of accounts matching the search query across all pages.

Errors

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

400Invalid request - query parameter is too short (minimum 3 characters) or validation failed
401Authentication required - missing or invalid access token