Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connected accounts

A connected account is one user's link to one connection, and holds that user's credentials for the app. See Manage connected accounts for when to check, refresh or delete one.

SDK helpers. get_or_create_connected_account (Python) and getOrCreateConnectedAccount (Node.js) get the user's connected account for a connection, or create it without credentials when there isn't one; Authorize a user and Manage connected accounts use them. actions.providers.list_providers (Python) and actions.providers.listProviders (Node.js) list connectors with their identifier, as Create a connector shows.

MethodEndpointPathWhat it doesSDKs
POSTCreate a connected accountCreate a user's connected account with credentials you already hold./api/v1/connected_accountsCreate a user's connected account with credentials you already hold.PythonNode.js
GETGet a connected accountGet an account's status, connection and settings, without its credentials./api/v1/connected_accounts/detailsGet an account's status, connection and settings, without its credentials.PythonNode.js: REST only
GETList connected accountsList accounts, filtered by connection, user, provider or organization./api/v1/connected_accountsList accounts, filtered by connection, user, provider or organization.PythonNode.js
GETSearch connected accountsFind accounts whose identifier, provider or connection matches a text query./api/v1/connected_accounts:searchFind accounts whose identifier, provider or connection matches a text query.Python: REST onlyNode.js: REST only
PUTUpdate a connected accountChange an account's settings, or import new credentials for it./api/v1/connected_accountsChange an account's settings, or import new credentials for it.PythonNode.js
GETGet a connected account's credentialsGet an account with its OAuth tokens or API key, to call the app yourself./api/v1/connected_accounts/authGet an account with its OAuth tokens or API key, to call the app yourself.PythonNode.js
POSTDelete a connected accountDelete an account and the user's stored credentials./api/v1/connected_accounts:deleteDelete an account and the user's stored credentials.PythonNode.js

This page as markdownWhole reference as one file