HelpCrunch API Documentation

This is the complete API documentation for connecting to the HelpCrunch API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet HelpCrunch: Manage customers, chats, messages, departments, and support activity in HelpCrunch. Keep reading to get started.

Quickstart

Before you run your first HelpCrunch request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one HelpCrunch connection — create or choose one in Connections. Note its connectionId.

Every HelpCrunch action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/helpCrunch/latest/actions/{actionSlug}

You need a MindCloud API Key and a HelpCrunch connection. Then call an action such as List Customers:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/helpCrunch/latest/actions/list-customers" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your HelpCrunch account. See HelpCrunch API Authentication for the full flow and how to get your connection credentials.

HelpCrunch actions

All 30 published actions for this HelpCrunch version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Customer Event
• PUTBatch Update Customers
• POSTCreate Agent Message
• POSTCreate Chat
• POSTCreate Customer
• POSTCreate Customer Message
• DELETEDelete Customer
• GETGet Chat
• GETGet Customer
• GETGet Team Availability Status
• GETList Applications
• GETList Chat Messages
• GETList Chats
• GETList Customers
• GETList Departments
• GETList Team Members
• PUTMark Chat As Read By Agent
• PUTMark Chat As Read By Customer
• PUTPatch Customer
• PUTRate Chat
• GETSearch Chats
• GETSearch Customers
• PUTSnooze Chat
• PUTTag Customer
• PUTUnsubscribe Team Member
• PUTUntag Customer
• PUTUpdate Chat Assignee
• PUTUpdate Chat Department
• PUTUpdate Chat Status
• PUTUpdate Customer

Related apps

More Support apps on the Universal API, behind the same REST shape. Or browse all apps.

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear