API OverviewAPI EndpointsIntegrations

Connect an integration

Initiates the connection process for a third-party integration using the Unified API

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
providerstringRequired

The integration provider (e.g., quickbooks, xero)

entityIdstringRequired
The ID of the entity to connect the integration for
connectionTypestringOptionalDefaults to provider

The type of connection to establish (used as scope in Unified API)

Response

Integration connection initiated successfully
workspaceIdstring or null
Unified workspace ID used for the connection

Errors