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
/api/integrationsList registered integrations and connection state for the current workspace
Connect or sync
/api/integrationsRegister credentials for a non-OAuth integration, or trigger a sync
| Parameter | Type | Description |
|---|---|---|
typerequired | string | Integration type: google_ads, google_analytics, hubspot, stripe, meta_ads, linkedin_ads, quickbooks |
action | string | Pass sync to refresh an existing connection |
credentials | object | API 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
/api/integrationsRemove an integration and revoke stored credentials
| Parameter | Type | Description |
|---|---|---|
typerequired | string | Integration type to disconnect |
OAuth flow
Start authorization
/api/integrations/:type/authRedirect the merchant to the platform's OAuth consent screen
| Parameter | Type | Description |
|---|---|---|
typerequired | string | Integration 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
/api/integrations/:type/callbackReceives 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
/api/sync/runTrigger a data sync for connected integrations
Syncs also run on a schedule. Use this when you just connected a platform and want an immediate refresh.