Skip to main content
GET
Get connected account details by ID

Authorizations

x-api-key
string
header
default:your-project-api-key
required

Your Composio project API key. Create or copy it from the Composio dashboard.

Path Parameters

nanoid
string<connectedAccountId>
required

The unique identifier (nanoid) of the connected account

Response

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

toolkit
object
required
auth_config
object
required
id
string<connectedAccountId>
required

The id of the connection

word_id
string | null
required

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

alias
string | null
required

A user-defined alias for the connected account

user_id
string
required
deprecated

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
enum<string>
required

The status of the connection

Available options:
INITIALIZING,
INITIATED,
ACTIVE,
FAILED,
EXPIRED,
INACTIVE,
REVOKED
created_at
string
required

The created at of the connection

updated_at
string
required

The updated at of the connection

state
object
required

The state of the connection

data
object
required
deprecated

This is deprecated, use state instead

status_reason
string | null
required

The reason the connection status changed.

is_disabled
boolean
required

Whether the connection is disabled

params
object
required
deprecated

The initialization data of the connection, including configuration parameters

authScheme
enum<string>
deprecated

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

Available options:
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
experimental
object

Experimental features - not stable, may be modified or removed in future versions.

test_request_endpoint
string

The endpoint to make test request for verification

requested_scopes
string[]

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_scopes
string[]

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