Api ReferenceIntegrations

Integrations

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

Endpoints

MethodPathDescription
GET/integrations/\{organization_id\}List integrations
GET/integrations/\{organization_id\}/flowsList integration flows
GET/integrations/\{organization_id\}/flows/\{flow_id\}Get integration flow
POST/integrations/flowsCreate integration flow
DELETE/integrations/\{organization_id\}/flows/\{flow_id\}Delete integration flow
POST/integrations/integrator/tokenGet integrator token
POST/integrations/account/selectSelect integration account
GET/integrations/request-installRequest 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

ParameterTypeDescription
organization_idstringOrganization ID

Response Body

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

Example

curl -X GET "https://api.app.bullseye.so/api/v1/integrations/org_abc123" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json"

List Integration Flows

Returns all integration flows for an organization.

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

Path Parameters

ParameterTypeDescription
organization_idstringOrganization ID

Query Parameters

ParameterTypeRequiredDescription
integrationIdstringNoFilter by integration ID

Response Body

Returns an array of integration flow objects.

Example

curl -X GET "https://api.app.bullseye.so/api/v1/integrations/org_abc123/flows" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json"

Get Integration Flow

Returns a single integration flow by ID.

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

Path Parameters

ParameterTypeDescription
organization_idstringOrganization ID
flow_idstringIntegration flow ID

Response Body

Returns the integration flow object.

Example

curl -X GET "https://api.app.bullseye.so/api/v1/integrations/org_abc123/flows/flow_xyz789" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json"

Create Integration Flow

Creates a new integration flow.

Method: POST
Path: /integrations/flows

Request Body

FieldTypeRequiredDescription
organizationIdstringYesOrganization ID
titlestringYesFlow title
nodesobjectNoFlow node configuration

Response Body

Returns the created integration flow object.

Example

curl -X POST "https://api.app.bullseye.so/api/v1/integrations/flows" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json" 
  -d '{"organizationId": "org_abc123", "title": "Lead Sync to Google Ads", "nodes": {}}'

Delete Integration Flow

Deletes an integration flow.

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

Path Parameters

ParameterTypeDescription
organization_idstringOrganization ID
flow_idstringIntegration flow ID

Response Body

Returns 200 on success.

Example

curl -X DELETE "https://api.app.bullseye.so/api/v1/integrations/org_abc123/flows/flow_xyz789" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json"

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

curl -X POST "https://api.app.bullseye.so/api/v1/integrations/integrator/token" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json" 
  -d '{"integrationType": "googleAds", "organizationId": "org_abc123"}'

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

curl -X POST "https://api.app.bullseye.so/api/v1/integrations/account/select" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json" 
  -d '{"organizationId": "org_abc123", "integrationType": "googleAds", "accountId": "acc_xyz"}'

Request Integration Install

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

Method: GET
Path: /integrations/request-install

Query Parameters

ParameterTypeRequiredDescription
integrationTypestringYesgoogleAds or facebookAds
organizationIdstringNoOrganization ID

Response Body

Returns a URL or instructions for completing the installation.

Example

curl -X GET "https://api.app.bullseye.so/api/v1/integrations/request-install?integrationType=googleAds&organizationId=org_abc123" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json"