Integrations

The integration endpoints let you list connected integrations, manage integration flows, obtain integrator tokens, select accounts, and request integration installation.

Endpoints

Method
Path
Description

GET

/integrations/{organization_id}

List integrations

GET

/integrations/{organization_id}/flows

List integration flows

GET

/integrations/{organization_id}/flows/{flow_id}

Get integration flow

POST

/integrations/flows

Create integration flow

DELETE

/integrations/{organization_id}/flows/{flow_id}

Delete integration flow

POST

/integrations/integrator/token

Get integrator token

POST

/integrations/account/select

Select integration account

GET

/integrations/request-install

Request integration install


List Integrations

Returns all integrations for an organization, including connection status and ads account information.

Method: GET Path: /integrations/{organization_id}

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

Response Body

Returns an array of integration objects with type, name, installed, adsAccounts, selectedAdsAccount, and connectedAt.

Example


List Integration Flows

Returns all integration flows for an organization.

Method: GET Path: /integrations/{organization_id}/flows

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

Query Parameters

Parameter
Type
Required
Description

integrationId

string

No

Filter by integration ID

Response Body

Returns an array of integration flow objects.

Example


Get Integration Flow

Returns a single integration flow by ID.

Method: GET Path: /integrations/{organization_id}/flows/{flow_id}

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

flow_id

string

Integration flow ID

Response Body

Returns the integration flow object.

Example


Create Integration Flow

Creates a new integration flow.

Method: POST Path: /integrations/flows

Request Body

Field
Type
Required
Description

organizationId

string

Yes

Organization ID

title

string

Yes

Flow title

nodes

object

No

Flow node configuration

Response Body

Returns the created integration flow object.

Example


Delete Integration Flow

Deletes an integration flow.

Method: DELETE Path: /integrations/{organization_id}/flows/{flow_id}

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

flow_id

string

Integration flow ID

Response Body

Returns 200 on success.

Example


Get Integrator Token

Returns a token for use with an integration (e.g., for OAuth or API access).

Method: POST Path: /integrations/integrator/token

Request Body

JSON object with integration-specific parameters (e.g., integrationType, organizationId).

Response Body

Returns the token or token URL.

Example


Select Integration Account

Selects which integration account (e.g., ads account) to use for the organization.

Method: POST Path: /integrations/account/select

Request Body

JSON object with organizationId, integrationType, and accountId (or equivalent).

Response Body

Returns the updated selection or confirmation.

Example


Request Integration Install

Initiates the installation flow for an integration (e.g., Google Ads, Facebook Ads).

Method: GET Path: /integrations/request-install

Query Parameters

Parameter
Type
Required
Description

integrationType

string

Yes

googleAds or facebookAds

organizationId

string

No

Organization ID

Response Body

Returns a URL or instructions for completing the installation.

Example

Last updated