# API reference

URL: https://www.inclamo.com/docs/api

> The HTTP API of Inclamo Helpdesk: the Application API and the Client API it inherits from Chatwoot, with a downloadable OpenAPI file.

*Last checked 22 November 2026*

Inclamo Helpdesk is built on [Chatwoot](https://github.com/chatwoot/chatwoot), and its HTTP API is Chatwoot’s. Use it to read and write conversations, contacts and messages from your own tools, or to build your own chat interface.

**Base URL:** `https://helpdesk.inclamo.com`

[Download the OpenAPI file (/docs/api/openapi.json)](/docs/api/openapi.json)

## Two APIs [#two-apis]

- **Application API** (`/api/v1/…`) — what your team can do in the helpdesk, as an API: conversations, messages, contacts, inboxes, labels, teams, reports and more. Authenticate with the access token in your **Profile settings** in Inclamo Helpdesk, sent as `Authorization: Bearer <token>` (the older `api_access_token` header still works). The token acts with your own role and permissions.
- **Client API** (`/public/api/v1/…`) — the public API of an inbox, for a chat interface of your own: create a contact, open a conversation and send messages as the shopper. It needs the inbox’s identifier, not a user’s token.

## What this reference covers [#what-this-reference-covers]

- Chatwoot v4.19.1: 136 operations of the Application API and the Client API, from Chatwoot's OpenAPI file (MIT License).
- Not included — Platform API (18 operations): accounts and users of the whole installation, for the operator of the installation only.
- Not included — CSAT survey page (1 operation): an HTML page shown to the customer, not an API.
- Not included — Audit Logs (1 operation): a Chatwoot Enterprise feature; Inclamo Helpdesk is built on the Community Edition.
- Not included — Path without the /api prefix (1 operation): /accounts/{account_id}/conversations/{conversation_id}/messages: a duplicate in Chatwoot's file of an Application API path.

## Endpoints [#endpoints]

## Client API

### Inbox API

- `GET /public/api/v1/inboxes/{inbox_identifier}` — Inbox details

### Contacts API

- `POST /public/api/v1/inboxes/{inbox_identifier}/contacts` — Create a contact
- `GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}` — Get a contact
- `PATCH /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}` — Update a contact

### Conversations API

- `GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations` — List all conversations
- `POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations` — Create a conversation
- `GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}` — Get a single conversation
- `POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_status` — Resolve a conversation
- `POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing` — Toggle typing status
- `POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/update_last_seen` — Update last seen and mark messages read

### Messages API

- `GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages` — List all messages
- `POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages` — Create a message
- `PATCH /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}` — Update a message

## Application API

### Account

- `GET /api/v1/accounts/{account_id}` — Get account details
- `PATCH /api/v1/accounts/{account_id}` — Update account

### Account AgentBots

- `GET /api/v1/accounts/{account_id}/agent_bots` — List all AgentBots
- `POST /api/v1/accounts/{account_id}/agent_bots` — Create an Agent Bot
- `GET /api/v1/accounts/{account_id}/agent_bots/{id}` — Get an agent bot details
- `DELETE /api/v1/accounts/{account_id}/agent_bots/{id}` — Delete an AgentBot
- `PATCH /api/v1/accounts/{account_id}/agent_bots/{id}` — Update an agent bot

### Agents

- `GET /api/v1/accounts/{account_id}/agents` — List Agents in Account
- `POST /api/v1/accounts/{account_id}/agents` — Add a New Agent
- `DELETE /api/v1/accounts/{account_id}/agents/{id}` — Remove an Agent from Account
- `PATCH /api/v1/accounts/{account_id}/agents/{id}` — Update Agent in Account

### Canned Responses

- `GET /api/v1/accounts/{account_id}/canned_responses` — List all Canned Responses in an Account
- `POST /api/v1/accounts/{account_id}/canned_responses` — Add a New Canned Response
- `DELETE /api/v1/accounts/{account_id}/canned_responses/{id}` — Remove a Canned Response from Account
- `PATCH /api/v1/accounts/{account_id}/canned_responses/{id}` — Update Canned Response in Account

### Custom Attributes

- `GET /api/v1/accounts/{account_id}/custom_attribute_definitions` — List all custom attributes in an account
- `POST /api/v1/accounts/{account_id}/custom_attribute_definitions` — Add a new custom attribute
- `GET /api/v1/accounts/{account_id}/custom_attribute_definitions/{id}` — Get a custom attribute details
- `DELETE /api/v1/accounts/{account_id}/custom_attribute_definitions/{id}` — Remove a custom attribute from account
- `PATCH /api/v1/accounts/{account_id}/custom_attribute_definitions/{id}` — Update custom attribute in Account

### Contacts

- `GET /api/v1/accounts/{account_id}/contacts` — List Contacts
- `POST /api/v1/accounts/{account_id}/contacts` — Create Contact
- `GET /api/v1/accounts/{account_id}/contacts/{id}` — Show Contact
- `PUT /api/v1/accounts/{account_id}/contacts/{id}` — Update Contact
- `DELETE /api/v1/accounts/{account_id}/contacts/{id}` — Delete Contact
- `GET /api/v1/accounts/{account_id}/contacts/{id}/conversations` — Contact Conversations
- `GET /api/v1/accounts/{account_id}/contacts/search` — Search Contacts
- `POST /api/v1/accounts/{account_id}/contacts/filter` — Contact Filter
- `POST /api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes` — Create contact inbox
- `GET /api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes` — Get Contactable Inboxes
- `POST /api/v1/accounts/{account_id}/actions/contact_merge` — Merge Contacts

### Contact Labels

- `GET /api/v1/accounts/{account_id}/contacts/{id}/labels` — List Labels
- `POST /api/v1/accounts/{account_id}/contacts/{id}/labels` — Add Labels

### Automation Rule

- `GET /api/v1/accounts/{account_id}/automation_rules` — List all automation rules in an account
- `POST /api/v1/accounts/{account_id}/automation_rules` — Add a new automation rule
- `GET /api/v1/accounts/{account_id}/automation_rules/{id}` — Get a automation rule details
- `DELETE /api/v1/accounts/{account_id}/automation_rules/{id}` — Remove a automation rule from account
- `PATCH /api/v1/accounts/{account_id}/automation_rules/{id}` — Update automation rule in Account

### Help Center

- `GET /api/v1/accounts/{account_id}/portals` — List all portals in an account
- `POST /api/v1/accounts/{account_id}/portals` — Add a new portal
- `GET /api/v1/accounts/{account_id}/portals/{portal_slug}` — Get a portal details
- `PATCH /api/v1/accounts/{account_id}/portals/{portal_slug}` — Update a portal
- `POST /api/v1/accounts/{account_id}/portals/{portal_slug}/categories` — Add a new category
- `POST /api/v1/accounts/{account_id}/portals/{portal_slug}/articles` — Add a new article

### Conversations

- `GET /api/v1/accounts/{account_id}/conversations/meta` — Get Conversation Counts
- `GET /api/v1/accounts/{account_id}/conversations` — Conversations List
- `POST /api/v1/accounts/{account_id}/conversations` — Create New Conversation
- `POST /api/v1/accounts/{account_id}/conversations/filter` — Conversations Filter
- `GET /api/v1/accounts/{account_id}/conversations/{conversation_id}` — Conversation Details
- `PATCH /api/v1/accounts/{account_id}/conversations/{conversation_id}` — Update Conversation
- `POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_status` — Toggle Status
- `POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority` — Toggle Priority
- `POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_typing_status` — Toggle Typing Status
- `POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/update_last_seen` — Update Last Seen
- `POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/custom_attributes` — Update Custom Attributes
- `POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/destroy_custom_attributes` — Destroy Custom Attributes
- `GET /api/v1/accounts/{account_id}/conversations/{conversation_id}/labels` — List Labels
- `POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/labels` — Add Labels
- `GET /api/v1/accounts/{account_id}/conversations/{conversation_id}/reporting_events` — Conversation Reporting Events

### Conversation Assignments

- `POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments` — Assign Conversation

### Inboxes

- `GET /api/v1/accounts/{account_id}/branded_email_layout` — Get account branded email layout
- `PATCH /api/v1/accounts/{account_id}/branded_email_layout` — Update account branded email layout
- `GET /api/v1/accounts/{account_id}/inboxes` — List all inboxes
- `POST /api/v1/accounts/{account_id}/inboxes` — Create an inbox
- `GET /api/v1/accounts/{account_id}/inboxes/{id}` — Get an inbox
- `PATCH /api/v1/accounts/{account_id}/inboxes/{id}` — Update Inbox
- `GET /api/v1/accounts/{account_id}/inboxes/{id}/message_templates` — List WhatsApp message templates
- `GET /api/v1/accounts/{account_id}/inboxes/{id}/agent_bot` — Show Inbox Agent Bot
- `POST /api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot` — Add or remove agent bot
- `GET /api/v1/accounts/{account_id}/inbox_members/{inbox_id}` — List Agents in Inbox
- `POST /api/v1/accounts/{account_id}/inbox_members` — Add a New Agent
- `DELETE /api/v1/accounts/{account_id}/inbox_members` — Remove an Agent from Inbox
- `PATCH /api/v1/accounts/{account_id}/inbox_members` — Update Agents in Inbox

### Labels

- `GET /api/v1/accounts/{account_id}/labels` — List all labels
- `POST /api/v1/accounts/{account_id}/labels` — Create a label
- `GET /api/v1/accounts/{account_id}/labels/{id}` — Get a label
- `DELETE /api/v1/accounts/{account_id}/labels/{id}` — Delete a label
- `PATCH /api/v1/accounts/{account_id}/labels/{id}` — Update a label

### Messages

- `GET /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages` — Get messages
- `POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages` — Create New Message
- `DELETE /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}` — Delete a message
- `PATCH /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}` — Update message status

### Integrations

- `GET /api/v1/accounts/{account_id}/integrations/apps` — List all the Integrations
- `POST /api/v1/accounts/{account_id}/integrations/hooks` — Create an integration hook
- `DELETE /api/v1/accounts/{account_id}/integrations/hooks/{hook_id}` — Delete an Integration Hook
- `PATCH /api/v1/accounts/{account_id}/integrations/hooks/{hook_id}` — Update an Integration Hook

### Profile

- `GET /api/v1/profile` — Fetch user profile
- `PUT /api/v1/profile` — Update user profile

### Teams

- `GET /api/v1/accounts/{account_id}/teams` — List all teams
- `POST /api/v1/accounts/{account_id}/teams` — Create a team
- `GET /api/v1/accounts/{account_id}/teams/{team_id}` — Get a team details
- `DELETE /api/v1/accounts/{account_id}/teams/{team_id}` — Delete a team
- `PATCH /api/v1/accounts/{account_id}/teams/{team_id}` — Update a team
- `GET /api/v1/accounts/{account_id}/teams/{team_id}/team_members` — List Agents in Team
- `POST /api/v1/accounts/{account_id}/teams/{team_id}/team_members` — Add a New Agent
- `DELETE /api/v1/accounts/{account_id}/teams/{team_id}/team_members` — Remove an Agent from Team
- `PATCH /api/v1/accounts/{account_id}/teams/{team_id}/team_members` — Update Agents in Team

### Custom Filters

- `GET /api/v1/accounts/{account_id}/custom_filters` — List all custom filters
- `POST /api/v1/accounts/{account_id}/custom_filters` — Create a custom filter
- `GET /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}` — Get a custom filter details
- `DELETE /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}` — Delete a custom filter
- `PATCH /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}` — Update a custom filter

### Webhooks

- `GET /api/v1/accounts/{account_id}/webhooks` — List all webhooks
- `POST /api/v1/accounts/{account_id}/webhooks` — Add a webhook
- `DELETE /api/v1/accounts/{account_id}/webhooks/{webhook_id}` — Delete a webhook
- `PATCH /api/v1/accounts/{account_id}/webhooks/{webhook_id}` — Update a webhook object

### Reports

- `GET /api/v1/accounts/{account_id}/reporting_events` — Account Reporting Events
- `GET /api/v2/accounts/{account_id}/reports` — Get Account reports
- `GET /api/v2/accounts/{account_id}/reports/summary` — Get Account reports summary
- `GET /api/v2/accounts/{account_id}/reports/conversations` — Account Conversation Metrics
- `GET /api/v2/accounts/{account_id}/reports/conversations/` — Agent Conversation Metrics
- `GET /api/v2/accounts/{account_id}/summary_reports/channel` — Get conversation statistics grouped by channel type
- `GET /api/v2/accounts/{account_id}/summary_reports/inbox` — Get conversation statistics grouped by inbox
- `GET /api/v2/accounts/{account_id}/summary_reports/agent` — Get conversation statistics grouped by agent
- `GET /api/v2/accounts/{account_id}/summary_reports/team` — Get conversation statistics grouped by team
- `GET /api/v2/accounts/{account_id}/reports/first_response_time_distribution` — Get first response time distribution by channel
- `GET /api/v2/accounts/{account_id}/reports/inbox_label_matrix` — Get inbox-label matrix report
- `GET /api/v2/accounts/{account_id}/reports/outgoing_messages_count` — Get outgoing messages count grouped by entity

### Campaigns

- `GET /api/v1/accounts/{account_id}/campaigns` — List campaigns
- `POST /api/v1/accounts/{account_id}/campaigns` — Create a campaign
- `GET /api/v1/accounts/{account_id}/campaigns/{id}` — Get a campaign
- `DELETE /api/v1/accounts/{account_id}/campaigns/{id}` — Delete a campaign
- `PATCH /api/v1/accounts/{account_id}/campaigns/{id}` — Update a campaign
