Integrations API

Connect external platforms (Google Ads, HubSpot, Stripe, and others) via OAuth, manage connections, and trigger data syncs.

The product word is Integration. /api/connectors is not a list or create route. Use /api/integrations. The old /api/connectors/:type/auth path still exists as a legacy alias of /api/integrations/:type/auth.

List integrations

GET/api/integrations

List registered integrations and connection state for the current workspace

curl https://app.apex.inc/api/integrations \ -H "x-api-key: apex_sk_..."

Connect or sync

POST/api/integrations

Register credentials for a non-OAuth integration, or trigger a sync

ParameterTypeDescription
typerequiredstringIntegration type: google_ads, google_analytics, hubspot, stripe, meta_ads, linkedin_ads, quickbooks
actionstringPass sync to refresh an existing connection
credentialsobjectAPI key credentials for non-OAuth integrations

Info

Most platforms use OAuth. Start that flow from the Integrations page, or from GET /api/integrations/:type/auth.

Disconnect

DELETE/api/integrations

Remove an integration and revoke stored credentials

ParameterTypeDescription
typerequiredstringIntegration type to disconnect
curl -X DELETE https://app.apex.inc/api/integrations \ -H "Content-Type: application/json" \ -H "x-api-key: apex_sk_..." \ -d '{ "type": "google_ads" }'

OAuth flow

Start authorization

GET/api/integrations/:type/auth

Redirect the merchant to the platform's OAuth consent screen

ParameterTypeDescription
typerequiredstringIntegration type (path parameter)
https://app.apex.inc/api/integrations/google_ads/auth

/api/connectors/:type/auth is a legacy alias of the same route.

OAuth callback

GET/api/integrations/:type/callback

Receives the OAuth authorization code and exchanges it for tokens

Warning

The OAuth provider calls this after the merchant grants access. Do not call it yourself.

On success, the merchant returns to the Integrations page with that platform connected.

Trigger sync

GET/api/sync/run

Trigger a data sync for connected integrations

curl "https://app.apex.inc/api/sync/run" \ -H "x-api-key: apex_sk_..."

Syncs also run on a schedule. Use this when you just connected a platform and want an immediate refresh.