POST
/
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

Body

application/json
data
object
required

The data required to initiate a connection. Structure varies by integration type.

integrationId
string
required

The ID of the integration for which the connection is being initiated. You can get this from the /api/v1/integrations endpoint.

Minimum length: 1
redirectUri
string

The URL to redirect to after the connection is successfully initiated.

userUuid
string

Deprecated: UUID of the user initiating the connection.

entityId
string

The entity ID to associate with the connection. Learn more about entities here.

labels
string[]

Array of labels to associate with the connection for organization and filtering.

Response

200 - application/json
connectionStatus
string
required

The current status of the initiated connection.

Minimum length: 1
connectedAccountId
string
required

The ID of the newly created connected account.

Minimum length: 1
redirectUrl
string

URL to redirect to for completing the connection process, if required.