REST API

Build integrations against ConnectGain.

Start here

• API overview — the three API types (Edge Functions, REST, external) with endpoint summaries.
• API key authentication — how cg_-prefixed keys work and which header to use.
• Complete API reference — full endpoint, field, and error reference.

Examples

• cURL samples — complete cURL requests for contacts, leads, and deals endpoints.
• REST cURL examples — CRUD examples for the REST API proxy.
• Proxy array search — searching array columns (phones, emails, tags) via the proxy.
• Inbox filters (cURL) — reproduce every inbox filter with PostgREST queries.

Resources

• Contacts & Deals API — technical reference for pushing CRM data from external systems.
• Deals API guide — creating, searching, and updating deals, with common pitfalls.
• Deals bulk behavior — how create-deals-bulk resolves and creates contacts.

Companion APIs

• Mobile API — login, contacts, and call-recording upload for mobile apps.
• Bot Control API — pause/resume the AI bot on conversations.

Postman

• Postman collection — import and test the public REST API (direct download).

---

ConnectGain — omnichannel inbox, CRM & automation for WhatsApp, Messenger, Instagram, Telegram and more. Open the app · Docs home