API ReferenceConnected Accounts

Create a new auth link sessionv3.1

Markdown
POST
/api/v3.1/connected_accounts/link

Creates a new authentication link session that users can use to connect their accounts

Authorization

x-api-key<token>

Project API key authentication

In: header

Request Body

application/json

auth_config_idstringRequired

The auth config id to create a link for

Format: authConfigId
user_idstringRequired

The user id to create a link for

aliasstring

A human-readable alias for this connected account. Must be unique per entity and toolkit within the project.

callback_urlstring

The callback url to create a link for

connection_dataobject

Optional data to pre-fill connection fields with default values

account_typeenum

Sharing model for this connected account. PRIVATE (default) is usable only by the owning user_id. SHARED is reachable from a tool-router session ONLY when explicitly pinned in the session config — at most one SHARED connection per toolkit per session. Sessions never use a SHARED connection implicitly. Set at creation time only — cannot be changed later.

Possible values:
PRIVATESHARED

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://backend.composio.dev/api/v3.1/connected_accounts/link" \  -H "Content-Type: application/json" \  -d '{    "auth_config_id": "string",    "user_id": "string"  }'
{
  "link_token": "string",
  "redirect_url": "string",
  "expires_at": "string",
  "connected_account_id": "string",
  "account_type": "PRIVATE"
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}