Build on Deskhero

Everything the Deskhero interface does, it does through this API. The same endpoints are available to you, documented here and runnable against your own workspace.

Authentication

Send a personal API token as a bearer token on every request:

Authorization: Bearer <your token>

Generate a token from your profile page in Deskhero. Treat it like a password: it carries your own permissions, and anyone holding it can act as you.

Signed in already? The reference pages can run requests for you directly, using your current session. No token needed.

Making a request

Most endpoints are scoped to a single workspace, and take its name in the path:

https://account.deskhero.com/api/<workspace>/v1.0/tickets

Endpoints that are not tied to a workspace use sys in the same position. Requests and responses are JSON, and every response is wrapped so that validation errors arrive in a predictable shape.

Rate limits

Up to 180 requests every 60 seconds. Some endpoints, sign in and password reset in particular, apply tighter limits of their own. Exceeding a limit returns 429; back off and retry rather than looping.

Getting started

Pick an endpoint from the index. Each page documents the route, the arguments, the response and the objects involved, with an example of both the request and the response body.

Something missing or wrong? Tell us at support@deskhero.com, these pages are generated from the API itself and we would rather fix them at the source.