OneDesk API Documentation

This is the complete API documentation for connecting to the OneDesk 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 OneDesk: Support customers and manage projects in one place with OneDesk's helpdesk, project management, and PSA platform. Keep reading to get started.

Quickstart

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

Every OneDesk action uses the same URL pattern:

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

You need a MindCloud API Key and a OneDesk connection. Then call an action such as Get Customer By External ID:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/oneDesk/latest/actions/get-customer-by-external-id" \
  --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 OneDesk account that should run the action. MindCloud stores and refreshes the OneDesk 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.

OneDesk actions

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

• POSTCreate Customer
• POSTCreate Customer Organization
• POSTCreate Project
• GETGet Customer By External ID
• GETGet Customer Organization By External ID
• GETGet Organization Lifecycle Status
• GETGet Organization Profile And Policy
• GETGet Project By External ID
• GETList Organization Container Types
• GETList Organization Item Types
• GETList Organization User Types
• GETSearch Customer Organizations
• GETSearch Customer Organizations With Details
• GETSearch Customers
• GETSearch Customers With Details
• GETSearch Projects
• GETSearch Projects With Details
• PUTUpdate Customer By External ID
• PUTUpdate Customer Organization By External ID
• PUTUpdate Project By External ID

Related apps

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

Google CalendarNotionTypeformJira Software CloudSmartsheetCal.comWufooBasecamp