Hello 👋🏼 How can we help?

Introduction

Get started with REST API

The API basics to help you get started

Written by Konstantine
Updated 2 months ago

Customers

Customer model

Details on every Customer Object field

Written by Konstantine
Updated 1 month ago

Get a single customer

Fetch the details of a single customer by their id

Written by Konstantine
Updated 1 month ago

Search for customers

Find customers by the value of their attributes

Written by Konstantine
Updated 4 weeks ago

Get all customers

Fetch a list of all customers or a bunch of customers

Written by Konstantine
Updated 1 month ago

Create customer

Add a single customer to your account

Written by Konstantine
Updated 1 month ago

Update customer

Update data of an existing customer by their id

Written by Konstantine
Updated 1 month ago

Butch update customers

Update customers in bulk

Written by Konstantine
Updated 2 months ago

Tag customer

Add tags to a single customer

Written by Konstantine
Updated 1 month ago

Untag customer

Remove tags from a single customer

Written by Konstantine
Updated 1 month ago

Add customer event

Submit a customer activity event

Written by Konstantine
Updated 2 months ago

Delete customer

Delete a single customer by their id

Written by Konstantine
Updated 2 months ago
See all articles (11) Hide articles

Chats

Chat model

Details on every Chat Object field

Written by Konstantine
Updated 2 months ago

Get a single chat

Fetch the details of a single chat by its id

Written by Konstantine
Updated 2 months ago

Search for chats

Find chats by the value of their attributes

Written by Konstantine
Updated 2 months ago

Get all chats

Fetch a list of all chats or a bunch of chats

Written by Konstantine
Updated 2 months ago

Create chat

Create a single chat on behalf of a specific customer

Written by Konstantine
Updated 2 months ago

Update chat status

Change the status of any chat

Written by Konstantine
Updated 2 months ago

Update chat assignee

Change agent the chat is assigned to

Written by Konstantine
Updated 2 months ago

Update chat department

Change department the chat is assigned to

Written by Konstantine
Updated 2 months ago

Snooze/unsnooze chat

Postpone chat for a specific day and time

Written by Konstantine
Updated 2 months ago
See all articles (9) Hide articles

Messages

Message model

Details on every Message Object field

Written by Konstantine
Updated 2 months ago

Get chat messages

Fetch all the messages from any chat

Written by Konstantine
Updated 2 months ago

Create message

Post messages to any chat on behalf of a customer or agent

Written by Konstantine
Updated 2 months ago

Agents

Agent model

Details on every Agent Object field

Written by Konstantine
Updated 2 months ago

Get all team members

Fetch a list of all team members for your account

Written by Konstantine
Updated 2 months ago

Unsubscribe team member

Unsubscribe any team member from HelpCrunch newsletters

Written by Konstantine
Updated 2 months ago

Departments

Department model

Details on every Department Object field

Written by Konstantine
Updated 2 months ago

Get all departments

Fetch a list of all departments for your account

Written by Konstantine
Updated 2 months ago

Applications

Application model

Details on every Application Object field

Written by Konstantine
Updated 2 months ago

Get all applications

List all web widgets and iOS/Android apps for your account

Written by Konstantine
Updated 2 months ago

Organization

Organization model

Details on every Organization Object field

Written by Konstantine
Updated 2 months ago

Get team availability status

Fetch info about your team online/offline status

Written by Konstantine
Updated 2 months ago

Additional articles

Upgrading to the newest REST API version

Set of guidelines for migration to the latest REST API version

Written by Konstantine
Updated 2 months ago