API ReferenceConnected Accounts

Get connected account details by ID

Markdown
GET
/api/v3/connected_accounts/{nanoid}

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

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

Path Parameters

nanoid*string

The unique identifier (nanoid) of the connected account

FormatconnectedAccountId

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://backend.composio.dev/api/v3/connected_accounts/con_1a2b3c4d5e6f"
{
  "toolkit": {
    "slug": "string"
  },
  "auth_config": {
    "id": "string",
    "auth_scheme": "OAUTH2",
    "is_composio_managed": true,
    "is_disabled": true,
    "deprecated": {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
    }
  },
  "id": "string",
  "user_id": "string",
  "status": "INITIALIZING",
  "created_at": "string",
  "updated_at": "string",
  "state": {
    "authScheme": "OAUTH1",
    "val": {
      "subdomain": "string",
      "your-domain": "string",
      "region": "string",
      "shop": "string",
      "account_url": "string",
      "COMPANYDOMAIN": "string",
      "extension": "string",
      "form_api_base_url": "string",
      "instanceEndpoint": "string",
      "api_url": "string",
      "borneo_dashboard_url": "string",
      "proxy_username": "string",
      "proxy_password": "string",
      "domain": "string",
      "version": "string",
      "dc": "string",
      "site_name": "string",
      "instanceName": "string",
      "account_id": "string",
      "your_server": "string",
      "server_location": "string",
      "base_url": "string",
      "status": "INITIALIZING",
      "oauth_token": "string",
      "authUri": "string",
      "oauth_token_secret": "string",
      "redirectUrl": "string",
      "callbackUrl": "string",
      "oauth_verifier": "string",
      "consumer_key": "string",
      "callback_url": "string",
      "error": "string",
      "error_description": "string",
      "expired_at": "string"
    }
  },
  "data": {
    "property1": null,
    "property2": null
  },
  "status_reason": "string",
  "is_disabled": true,
  "test_request_endpoint": "string",
  "deprecated": {
    "labels": [
      "string"
    ],
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "params": {
    "property1": null,
    "property2": null
  }
}
{
  "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"
    ]
  }
}