# HelpDesk API Documentation

This is the complete API documentation for connecting to the HelpDesk API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **HelpDesk connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

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

## HelpDesk actions

- GET `get-agent` Get Agent
- GET `get-blocked-email` Get Blocked Email
- GET `get-canned-response` Get Canned Response
- GET `get-custom-field` Get Custom Field
- GET `get-email-domain` Get Email Domain
- GET `get-failed-outgoing-emails-report` Get Failed Outgoing Emails Report
- GET `get-license` Get License
- GET `get-macro` Get Macro
- GET `get-mailbox` Get Mailbox
- GET `get-new-tickets24h-distribution-report` Get New Tickets 24h Distribution Report
- GET `get-new-tickets-report` Get New Tickets Report
- GET `get-reply-address` Get Reply Address
- GET `get-resolution-time24h-distribution-report` Get Resolution Time 24h Distribution Report
- GET `get-resolution-time-per-agent-report` Get Resolution Time Per Agent Report
- GET `get-resolution-time-per-team-report` Get Resolution Time Per Team Report
- GET `get-resolution-time-report` Get Resolution Time Report
- GET `get-response-time24h-distribution-report` Get Response Time 24h Distribution Report
- GET `get-response-time-per-agent-report` Get Response Time Per Agent Report
- GET `get-response-time-per-team-report` Get Response Time Per Team Report
- GET `get-response-time-report` Get Response Time Report
- GET `get-rule` Get Rule
- GET `get-tag` Get Tag
- GET `get-team` Get Team
- GET `get-template` Get Template
- GET `get-ticket` Get Ticket
- GET `get-ticket-rating24h-distribution-report` Get Ticket Rating 24h Distribution Report
- GET `get-ticket-rating-report` Get Ticket Rating Report
- GET `get-ticket-sources24h-distribution-report` Get Ticket Sources 24h Distribution Report
- GET `get-ticket-status24h-distribution-report` Get Ticket Status 24h Distribution Report
- GET `get-ticket-status-report` Get Ticket Status Report
- GET `get-tickets-status-per-agent-report` Get Tickets Status Per Agent Report
- GET `get-tickets-status-per-team-report` Get Tickets Status Per Team Report
- GET `get-trusted-email` Get Trusted Email
- GET `get-view` Get View
- GET `list-agents` List Agents
- GET `list-audit-log` List Audit Log
- GET `list-blocked-emails` List Blocked Emails
- GET `list-canned-responses` List Canned Responses
- GET `list-custom-fields` List Custom Fields
- GET `list-email-domains` List Email Domains
- GET `list-licenses` List Licenses
- GET `list-macros` List Macros
- GET `list-mailboxes` List Mailboxes
- GET `list-reply-addresses` List Reply Addresses
- GET `list-rules` List Rules
- GET `list-subscriptions` List Subscriptions
- GET `list-tags` List Tags
- GET `list-teams` List Teams
- GET `list-templates` List Templates
- GET `list-tickets` List Tickets
- GET `list-trusted-emails` List Trusted Emails
- GET `list-views` List Views