SupportBee API Documentation
This is the complete API documentation for connecting to the SupportBee 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 SupportBee: SupportBee is a customer support help desk and shared inbox platform for managing tickets, replies, comments, teams, labels, and inbox workflows. Keep reading to get started.
Quickstart
Before you run your first SupportBee 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 SupportBee connection — create or choose one in Connections. Note its
connectionId.
Every SupportBee action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/supportBee/actions/{actionSlug}/runYou need a MindCloud API Key and a SupportBee connection. Then call an action such as List Tickets:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/supportBee/actions/list-tickets/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 SupportBee account. See SupportBee API Authentication for the full flow and how to get your connection credentials.
SupportBee actions
All 24 published actions for this SupportBee version. Each page documents the endpoint, arguments, and response controls.
- PUTAdd Label to Ticket
- PUTArchive Ticket
- PUTAssign Ticket to Team
- PUTAssign Ticket to User
- POSTCreate Comment
- POSTCreate Reply
- POSTCreate Ticket
- GETGet Ticket
- GETGet User
- GETList Labels
- GETList Teams
- GETList Ticket Comments
- GETList Ticket Replies
- GETList Tickets
- GETList Users
- PUTMark Ticket Answered
- PUTMark Ticket as Spam
- PUTMark Ticket Unanswered
- PUTRestore Ticket
- GETSearch Tickets
- PUTTrash Ticket
- PUTUnarchive Ticket
- PUTUnassign Ticket from Team
- PUTUnassign Ticket from User
Related apps
More Support apps on the Universal API, behind the same REST shape. Or browse all apps.