Skip to content

API overview

The Connectora API is versioned under /api/v1. Admin and automations use Bearer JWT plus X-Organization-Id.

Auth

  • POST /api/v1/auth/login - obtain token
  • GET /api/v1/auth/me - user, org, entitlements

Docs handoff

  • POST /api/v1/docs/handoff - authenticated one-time code for docs.connectora-sync.com
  • POST /api/v1/docs/exchange - public exchange of code -> short-lived docs session

Product surfaces (selected)

AreaExamples
Inbox/conversations, /conversations/:id/commerce, messages, notes
CRM/contacts, /tags
Campaigns/broadcasts, /broadcasts/audience_preview, /broadcasts/:id/cancel
Analytics/analytics/overview?period=7d|30d
WhatsApp/whatsapp_accounts, /whatsapp/meta_app, /message_templates
Stores/store_connections, /integrations/shopify/authorize

Webhooks:

  • WhatsApp BYO: /webhooks/whatsapp/:organization_id
  • WhatsApp platform app: /webhooks/whatsapp
  • Shopify: /webhooks/shopify/*

Plan notes: many write endpoints enforce features via PlanGatable (automations, workflows, plugins).