Reamaze API Documentation
This is the complete API documentation for connecting to the Reamaze 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 Reamaze: Reamaze is a customer support platform for conversations, contacts, channels, knowledge base content, staff workflows, response templates, reports, and status-page incidents. Keep reading to get started.
Quickstart
Before you run your first Reamaze 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 Reamaze connection — create or choose one in Connections. Note its
connectionId.
Every Reamaze action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/reamaze/actions/{actionSlug}/runYou need a MindCloud API Key and a Reamaze connection. Then call an action such as List Conversations:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/reamaze/actions/list-conversations/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'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 Reamaze account. See Reamaze API Authentication for the full flow and how to get your connection credentials.
Reamaze actions
All 38 published actions for this Reamaze version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Article
- POSTCreate Contact
- POSTCreate Contact Note
- POSTCreate Conversation
- POSTCreate Identity
- POSTCreate Incident
- POSTCreate Message
- POSTCreate Response Template
- POSTCreate Staff
- DELETEDelete Contact Note
- GETGet Article
- GETGet Channel
- GETGet Channel Summary Report
- GETGet Conversation
- GETGet Incident
- GETGet Response Template
- GETGet Response Time Report
- GETGet Staff Report
- GETGet Tags Report
- GETGet Volume Report
- GETList Articles
- GETList Channels
- GETList Contact Identities
- GETList Contact Notes
- GETList Contacts
- GETList Conversations
- GETList Incidents
- GETList Messages
- GETList Response Templates
- GETList Satisfaction Ratings
- GETList Staff
- GETList Systems
- PUTUpdate Article
- PUTUpdate Contact
- PUTUpdate Contact Note
- PUTUpdate Conversation
- PUTUpdate Incident
- PUTUpdate Response Template
Related apps
More Support apps on the Universal API, behind the same REST shape. Or browse all apps.