Skip to content

Postman Collection

Use the official ConnectGain Postman collection to explore and test the public REST API without writing any code.

Download the ConnectGain collection

What's inside

Every request in this collection authenticates the same way — with a cg_ API key in the X-API-Key header — so it maps to the public integration API surface:

  • Search — search contacts and companies
  • Messages — insert an inbound message from an external system
  • Leads & Deals — single and bulk lead creation, bulk deal ingestion, bulk contact import
  • Call Intelligence — call-recording webhook ingestion
  • Organizations — list your organizations by API key

API-key endpoints only

This collection is intentionally scoped to endpoints that authenticate with an API key. Platform-admin endpoints are internal and excluded. The JWT-authenticated Supabase REST endpoints (contacts, deals, conversations, …) are documented on the Complete API Reference and REST API cURL Examples pages — use a signed-in user session for those.

See the Complete API Reference for the full endpoint list and the Authentication guide for how keys work.

Import & configure

  1. In Postman, choose Import and select the downloaded ConnectGain.postman_collection.json file.
  2. Set the url collection variable — for production use the Edge Functions base from the API Overview.
  3. Set the api_key collection variable to your key. Every request sends it as:
X-API-Key: cg_your_api_key_here

Generate a key in the app under Settings → Storage & Developer → API Keys. Keys are prefixed cg_. Keep them secret — treat a key like a password.

Authentication recap

This collection's endpoints authenticate with cg_-prefixed API keys sent in the X-API-Key header. Full details, scopes and rotation are in API Authentication.

cURL instead?

Prefer the command line? See cURL Samples and REST API cURL Examples.


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