HelpDesk API Documentation

This is the complete API documentation for connecting to the HelpDesk 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 HelpDesk: Manage tickets, teams, tags, and helpdesk workflows. Keep reading to get started.

Quickstart

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

Every HelpDesk action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/helpDesk/actions/{actionSlug}/run

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

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/helpDesk/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 HelpDesk account. See HelpDesk API Authentication for the full flow and how to get your connection credentials.

HelpDesk actions

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

• GETGet Agent
• GETGet Blocked Email
• GETGet Canned Response
• GETGet Custom Field
• GETGet Email Domain
• GETGet Failed Outgoing Emails Report
• GETGet License
• GETGet Macro
• GETGet Mailbox
• GETGet New Tickets 24h Distribution Report
• GETGet New Tickets Report
• GETGet Reply Address
• GETGet Resolution Time 24h Distribution Report
• GETGet Resolution Time Per Agent Report
• GETGet Resolution Time Per Team Report
• GETGet Resolution Time Report
• GETGet Response Time 24h Distribution Report
• GETGet Response Time Per Agent Report
• GETGet Response Time Per Team Report
• GETGet Response Time Report
• GETGet Rule
• GETGet Tag
• GETGet Team
• GETGet Template
• GETGet Ticket
• GETGet Ticket Rating 24h Distribution Report
• GETGet Ticket Rating Report
• GETGet Ticket Sources 24h Distribution Report
• GETGet Ticket Status 24h Distribution Report
• GETGet Ticket Status Report
• GETGet Tickets Status Per Agent Report
• GETGet Tickets Status Per Team Report
• GETGet Trusted Email
• GETGet View
• GETList Agents
• GETList Audit Log
• GETList Blocked Emails
• GETList Canned Responses
• GETList Custom Fields
• GETList Email Domains
• GETList Licenses
• GETList Macros
• GETList Mailboxes
• GETList Reply Addresses
• GETList Rules
• GETList Subscriptions
• GETList Tags
• GETList Teams
• GETList Templates
• GETList Tickets
• GETList Trusted Emails
• GETList Views

Related apps

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

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear