Connected Accounts

List connected accounts with optional filters

Changed on

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.

get/api/v3.1/connected_accounts

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/connected_accounts
  • Auth
    • API key in header x-api-key
    • or API key in header x-user-api-key

Query parameters

toolkit_slugsstring[] nullable

The toolkit slugs of the connected accounts

statusesstring[] nullable

The status of the connected account

cursorstring nullable

The cursor to paginate through the connected accounts

limitnumber nullable

The limit of the connected accounts to return

user_idsstring[] nullable

The user ids of the connected accounts

auth_config_idsstring[] nullable

The auth config ids of the connected accounts

connected_account_idsstring[] nullable

The connected account ids to filter by

order_by'created_at' | 'updated_at'

The order by of the connected accounts

order_direction'asc' | 'desc'

The order direction of the connected accounts

account_type'PRIVATE' | 'SHARED' | 'ALL'

[Experimental] Filter by sharing model. Default (omitted) returns PRIVATE only — shared accounts must be requested explicitly. Pass SHARED for only shared accounts, or ALL for PRIVATE + SHARED.

Response

Successfully retrieved connected accounts

next_cursorstring nullable
total_pagesnumber required
current_pagenumber required
total_itemsnumber required

Changes

    • breaking

      the // response's property type changed from no type to object for status

    • warning

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

    • info

      api operation id getV3_1ConnectedAccounts removed and replaced with getConnectedAccounts

    • info

      added the optional property // to the response with the status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 subschema #12 subschema #13 subschema #14 from the // response property oneOf list for the response status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property // from the response with the status