Sign in
Connected Accounts
Account Management

Get connected account details by ID

Retrieves comprehensive details of a connected account, including authentication configuration, connection status, and all parameters needed for API requests.

get/api/v3/connected_accounts/{nanoid}

Path parameters

nanoidstring connectedAccountId required

The unique identifier (nanoid) of the connected account

Response

Successfully retrieved connected account details with all authentication parameters and connection status

idstring connectedAccountId required

The id of the connection

authScheme'OAUTH2' | 'OAUTH1' | 'API_KEY' | 'BASIC' | 'BILLCOM_AUTH' | 'BEARER_TOKEN' | 'GOOGLE_SERVICE_ACCOUNT' | 'NO_AUTH' | 'BASIC_WITH_JWT' | 'CALCOM_AUTH' | 'SERVICE_ACCOUNT' | 'SAML' | 'DCR_OAUTH' | 'CIMD_OAUTH' | 'S2S_OAUTH2'

Duplicates state.authScheme. Kept for backward compatibility with existing readers; use state.authScheme instead.

word_idstring nullable required

A short, token-friendly identifier for multi-account disambiguation, typically toolkit-prefixed with 1-2 words (e.g., "gmail_red-castle")

aliasstring nullable required

A user-defined alias for the connected account

user_idstring required

This is deprecated, we will not be providing userId from this api anymore, you will only be able to read via userId not get it back

status'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED' | 'INACTIVE' | 'REVOKED' required

The status of the connection

created_atstring required

The created at of the connection

updated_atstring required

The updated at of the connection

dataobject required

This is deprecated, use state instead

status_reasonstring nullable required

The reason the connection status changed.

is_disabledboolean required

Whether the connection is disabled

test_request_endpointstring

The endpoint to make test request for verification

paramsobject required

The initialization data of the connection, including configuration parameters

requested_scopesstring[]

OAuth scopes requested when this connection was most recently initiated (create or refresh). Absent for connections created before scope snapshots were captured and for non-OAuth auth schemes.

requested_user_scopesstring[]

OAuth user-token scopes requested at the most recent initiation. Only meaningful for Slackbot auth configs (user-token scopes); absent otherwise.

Changes

Changed in 1 of the 10 revisions of this API.12

  • 1418e4c88ab212See the full diff
    • ▲

      added subschema #14 to the state response property oneOf list for the response status 200

      response-property-one-of-added

    • ●

      added the new CIMD_OAUTH enum value to the authScheme response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CIMD_OAUTH enum value to the auth_config/auth_scheme response property for the response status 200

      response-property-enum-value-added