Docs

Zendesk API Documentation

This is the complete API documentation for connecting to the Zendesk 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 Zendesk: Manage tickets, answer customers, build help centers, and track service. Keep reading to get started.

Quickstart

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

Every Zendesk action uses the same URL pattern:

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

You need a MindCloud API Key and a Zendesk connection. Then call an action such as Execute View:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/zendesk/latest/actions/execute-view" \
  --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 Zendesk account that should run the action. MindCloud stores and refreshes the Zendesk 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.

Connect Zendesk with an API token

You need a Zendesk administrator account to create the API token, plus the Subdomain, Email address, and API token values for the connection form. Zendesk shows the full API token only once when you create it.

  1. Turn on API token access in Zendesk

    In Zendesk Admin Center, go to Apps and integrations > APIs > API configuration. If this is your first time using the API, accept the terms and click Get started. Turn on Allow API token access and click Save.

    Admin Center → Apps and integrations → APIs → API configuration

  2. Create an API token

    Go to Apps and integrations > APIs > API tokens. Click Add API token, optionally enter a description, click Save, then copy the full token immediately. Zendesk will not show the full token again after you close the window.

    Admin Center → Apps and integrations → APIs → API tokens

  3. Find your subdomain and email address

    Use your Zendesk URL to fill Subdomain in the connection form. For example, if your Zendesk URL is https://mindcloudhelp.zendesk.com, enter mindcloudhelp. Use the Email address of a verified Zendesk user on the account.

  4. Complete the connection form

    Return to the connection form and enter Subdomain, Email address, and API token.

Zendesk actions

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

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