API Schema
This reference covers all REST endpoints available to third-party apps via the CRM API. Read the API Requests overview for authentication, request format, pagination, and error conventions before diving into individual endpoints.
Agents
List and retrieve agents within a workspace. Use these endpoints to resolve agent identities when routing conversations or displaying sender information in your app.
Apps
Manage app-level event configuration. These endpoints let your app register and update the triggers that determine when the CRM notifies your integration.
Bots
Create and manage chatbot configurations. Bots can be assigned to conversations to handle automated responses before or instead of a human agent.
Channels
Retrieve available communication channels in a workspace. Channels represent the messaging surfaces (e.g. Telegram) through which conversations occur.
Chatbot Conversations
Control chatbot state within a conversation. Use these endpoints to hand off a conversation from a bot to a human agent, or to resume bot handling after an agent interaction.
Chats
Core conversation and message operations. This is the largest resource group: it covers creating conversations, sending messages (including attachments, whispers, and announcements), reading conversation history, and updating conversation state.
Contacts
Look up and manage contacts. Contacts are the external parties (customers, end users) on the other side of a conversation. These endpoints support searching by identifier and retrieving contact details.