API Referencev1Connections

Initiate connection

Headers

x-api-keystringRequired

Request

InitiateConnectionPayloadDto
dataobjectRequired
The data required to initiate a connection. Structure varies by integration type.
integrationIdstringRequired>=1 character

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

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

Deprecated: UUID of the user initiating the connection.

entityIdstringOptional

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

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

Response

Initiates a connection for the given integration and mark the connection status as initiated if the auth scheme is OAuth1 or OAuth2
connectionStatusstring>=1 character
The current status of the initiated connection.
connectedAccountIdstring>=1 character
The ID of the newly created connected account.
redirectUrlstring or null
URL to redirect to for completing the connection process, if required.