OneHash API Documentation
This is the complete API documentation for connecting to the OneHash 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 OneHash: OneHash Chat is a customer support workspace built on the Chatwoot API contract. This app wraps the authenticated account-scoped API for contacts, conversations, inboxes, teams, labels, canned responses, webhooks, and related support operations. Keep reading to get started.
Quickstart
Before you run your first OneHash request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one OneHash connection — create or choose one in Connections. Note its
connectionId.
Every OneHash action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/oneHash/latest/actions/{actionSlug}You need a MindCloud API Key and a OneHash connection. Then call an action such as Filter Contacts:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/oneHash/latest/actions/filter-contacts" \
--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.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected OneHash account that should run the action. MindCloud stores and refreshes the OneHash credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
OneHash actions
All 37 published actions for this OneHash version. Each page documents the endpoint, arguments, and response controls.
- PUTAdd Contact Labels
- PUTAdd Conversation Labels
- PUTAssign Conversation
- POSTCreate Canned Response
- POSTCreate Contact
- POSTCreate Contact Inbox
- POSTCreate Conversation
- POSTCreate Conversation Message
- POSTCreate Label
- DELETEDelete Canned Response
- DELETEDelete Contact
- DELETEDelete Label
- GETFilter Contacts
- GETFilter Conversations
- GETGet Account Details
- GETGet Contact
- GETGet Conversation
- GETGet Conversation Counts
- GETGet Conversation Reporting Events
- GETGet Label
- GETList Canned Responses
- GETList Contact Conversations
- GETList Contact Labels
- GETList Contacts
- GETList Conversation Labels
- GETList Conversation Messages
- GETList Conversations
- GETList Labels
- GETSearch Contacts
- PUTToggle Conversation Priority
- PUTToggle Conversation Status
- PUTToggle Conversation Typing Status
- PUTUpdate Canned Response
- PUTUpdate Contact
- PUTUpdate Conversation
- PUTUpdate Conversation Custom Attributes
- PUTUpdate Label
Related apps
More Support apps on the Universal API, behind the same REST shape. Or browse all apps.