API ReferenceConnected Accounts

List connected accounts with optional filters

Markdown
GET/api/v3/connected_accounts

Retrieves all connected accounts for your project. Connected accounts represent authenticated user connections to external services (e.g., a user's Gmail account, Slack workspace). Filter by toolkit, status, user ID, or auth config to find specific connections.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

Query Parameters

toolkit_slugsnullable array

The toolkit slugs of the connected accounts

statusesnullable array

The status of the connected account

cursornullable string

The cursor to paginate through the connected accounts

limitnullable number

The limit of the connected accounts to return

user_idsnullable array

The user ids of the connected accounts

auth_config_idsnullable array

The auth config ids of the connected accounts

connected_account_idsnullable array

The connected account ids to filter by

order_byenum

The order by of the connected accounts

Default: "created_at"
Possible values:
created_atupdated_at
order_directionenum

The order direction of the connected accounts

Default: "desc"
Possible values:
ascdesc

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://backend.composio.dev/api/v3/connected_accounts"
{
  "items": [
    {
      "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"
      }
    }
  ],
  "next_cursor": "string",
  "total_pages": 0,
  "current_page": 0,
  "total_items": 0
}
{
  "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"
    ]
  }
}