HelpSpace API Documentation

This is the complete API documentation for connecting to the HelpSpace 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 HelpSpace: HelpSpace is a customer support platform API for tickets, ticket messages, customers, scrum tasks, knowledge-base docs, tags, reports, and webhook configuration. Keep reading to get started.

Quickstart

Before you run your first HelpSpace 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 HelpSpace connection — create or choose one in Connections. Note its connectionId.

Every HelpSpace action uses the same URL pattern:

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

You need a MindCloud API Key and a HelpSpace connection. Then call an action such as Get Attachment Media:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/helpSpace/latest/actions/get-attachment-media" \
  --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 HelpSpace account that should run the action. MindCloud stores and refreshes the HelpSpace 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.

HelpSpace actions

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

• POSTCreate Customer
• POSTCreate Tag
• POSTCreate Task
• POSTCreate Ticket
• POSTCreate Ticket Message
• DELETEDelete Customer
• DELETEDelete Tag
• DELETEDelete Task
• DELETEDelete Ticket
• GETGet Attachment Media
• GETGet Channels Report
• GETGet Customer
• GETGet Customer Avatar
• GETGet Docs Article
• GETGet Inline Media
• GETGet Performance Report
• GETGet Tag
• GETGet Task
• GETGet Ticket
• GETGet Ticket Message
• GETGet Webhook
• GETList Customers
• GETList Docs Articles
• GETList Docs Categories
• GETList Docs Sites
• GETList Tags
• GETList Tasks
• GETList Ticket Messages
• GETList Tickets
• GETList Webhook Logs
• PUTUpdate Customer
• PUTUpdate Customer Avatar
• PUTUpdate Tag
• PUTUpdate Task
• PUTUpdate Ticket
• PUTUpdate Webhook

Related apps

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

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear