GET
/
api
/
v1
/
connectedAccounts

Authorizations

x-api-key
string
headerrequired

API key for authentication, you can easily get it from the dashboard after login or if you are using CLI, you can get it from the composio whoami command

Query Parameters

page
number

The page number for pagination. Defaults to 1 if not specified.

Required range: x > 1
pageSize
number

The number of items per page for pagination. Defaults to 99999999 if not specified - this is a temporary fix to support backward compatibility issues. Please specify this value to avoid fetching all connections at once.

Required range: x > 1
appNames
string

Comma-separated list of app names to filter connections by. You can get the app names from the /api/v1/apps endpoint.

labels
string

Comma-separated list of labels to filter connections by.

showActiveOnly
boolean

Flag to show only active connections. Defaults to false if not specified.

status
enum<string>

The status of the connection to filter by.

Available options:
INITIATED,
ACTIVE,
FAILED
integrationId
string

The ID/UUID of the integration to filter connections by. You can get the integration ID from the /api/v1/integrations endpoint.

connectionId
string

UUID of the connected account you want to get auth credentials for. You can get this from the id field in the response of the /api/v1/connectedAccounts endpoint.

user_uuid
string
deprecated

Comma-separated list of entity IDs to filter connections by. This field is deprecated - please use entityId instead.

entityId
string

Comma-separated list of entity ids of the user to filter connections by. Learn more about entities here.

showDisabled
boolean

Flag to include disabled connections in the results. Defaults to false if not specified.

Response

200 - application/json
items
object[]
required

Array of connection objects matching the query parameters.

totalPages
number
required

Total number of pages available based on the pageSize.

page
number
required

Current page number in the pagination.