# HelloCRM Public API

> Integrator REST API for HelloCRM — conversations, messaging (live chat, email, SMS, WhatsApp, bulk), templates, contacts, companies, products, deals, and quotes.

## Canonical documentation

- Markdown (full reference, AI-friendly): https://developers.hellocrm.ai/API.md
- Interactive OpenAPI UI: https://developers.hellocrm.ai/
- OpenAPI 3.0 JSON: https://developers.hellocrm.ai/openapi.json
- Postman collection: https://developers.hellocrm.ai/hello-crm.postman_collection.json
- Code samples (cURL, Python, Go, Java, etc.): https://developers.hellocrm.ai/testing.html

## API base URL

https://api.hellocrm.ai

## Authentication

- Header: `x-api-key: YOUR_TEAM_API_KEY` (required for integrator routes)
- Optional: `Authorization: Bearer <jwt>`

## Common headers

- `Content-Type: application/json` (requests with a body)
- `Accept: application/json`
- `Idempotency-Key: <unique-id>` (recommended on creates and message sends)

## Success response shape

```json
{ "success": true, "message": "string", "data": {}, "meta": {} }
```

## Resource groups

- Conversations: resolve by phone/email, create contact+conversation, create by contactId, get/list, messages
- Messaging modes: **in conversation** (`conversationId`) OR **standalone** (`to`, `contactId`, `recipientId` — auto find/create contact + conversation)
- Send Live Chat: POST /api/messages/sendLiveMessage
- Send Email: POST /api/messages/sendEmailMessage
- Send SMS / Send WhatsApp: POST /api/messages/sendMessage (channel sms or whatsapp)
- Bulk Email / Bulk SMS / Bulk WhatsApp: POST /api/messages/sendBulkNewMessages
- Templates: GET/POST /api/templates, GET/PUT/DELETE /api/templates/{templateId}
- Contacts: CRUD and upsert
- Companies: create, edit, delete
- Products: CRUD
- Deals: create, edit, delete
- Quotes: create from deal, update, delete