Postman collection

The HelloCRM documented public API collection covers messages (single and bulk), contacts, companies, products, deals, and quotes. It is generated from hellocrm-backend/scripts/generate-postman-collection.mjs in the main repository.

When this site is hosted at https://developers.hellocrm.ai, you can import the collection using that host in the URL below. Keep Postman environment variable baseUrl set to https://api.hellocrm.ai (no trailing slash)—that is where API requests are sent.

Import this site’s collection file

1. Open Postman → Import.
2. Choose Link and paste the URL shown below (or copy from the address bar after opening the JSON file).

You can also open the raw file directly: /hello-crm.postman_collection.json

Environment variables

Create a Postman environment with:

• baseUrl — e.g. https://api.hellocrm.ai (no trailing slash).
• apiKey — your team API key (sent as header x-api-key).

Optional: set collection variables on the collection itself instead of an environment.

Headers

• Content-Type: application/json on requests with a body.
• Idempotency-Key — use a unique value per logical operation when creating resources or sending messages so retries are safe.

Regenerate from source

cd hellocrm-backend
npm run postman:generate

This updates postman/HelloCRM.postman_collection.json, openapi.json, and the copy hosted here.