↔️ REST API
Control customers, chats, messages and more programmatically or sync data with third-party services.Introduction
Get started with REST API
The API basics to help you get started
Customers
Customer model
Details on every Customer Object field
Get a single customer
Fetch the details of a single customer by their id
Get all customers
Fetch a list of all customers or a bunch of customers
Search for customers
Find customers by the value of their attributes
Untag customer
Remove tags from a single customer
Tag customer
Add tags to a single customer
Add customer event
Submit a customer activity event
Delete customer
Delete a single customer by their id
Batch update customers
Update customers in bulk
Update customer
Update data of an existing customer by their id
Create customer
Add a single customer to your account
Chats
Chat model
Details on every Chat Object field
Get a single chat
Fetch the details of a single chat by its id
Get all chats
Fetch a list of all chats or a bunch of chats
Search for chats
Find chats by the value of their attributes
Create chat
Create a single chat on behalf of a specific customer
Update chat department
Change department the chat is assigned to
Mark chat as read
Mark chats as read using the API
Snooze/unsnooze chat
Postpone chat for a specific day and time
Update chat assignee
Change agent the chat is assigned to
Update chat status
Change the status of any chat
Rate chat
Rate closed chats using the API
Messages
Message model
Details on every Message Object field
Create message
Post messages to any chat on behalf of a customer or agent
Get chat messages
Fetch all the messages from any chat
Agents
Agent model
Details on every Agent Object field
Get all team members
Fetch a list of all team members for your account
Unsubscribe team member
Unsubscribe any team member from HelpCrunch newsletters
Departments
Department model
Details on every Department Object field
Get all departments
Fetch a list of all departments for your account
Applications
Application model
Details on every Application Object field
Get all applications
List all web widgets and iOS/Android apps for your account
Organization
Get team availability status
Fetch info about your team online/offline status
Organization model
Details on every Organization Object field
Additional articles
Upgrading to the newest REST API version
Set of guidelines for migration to the latest REST API version