Question 1

How do I generate an API token?

Accepted Answer

1) Open your profile and go to the API page. 2) Click "Generate API token". 3) Enter the name of the application that will use the token. 4) Click "Generate". 5) Copy the token right away using "Copy and close". As the warning says, "Make sure to store the token safely. You will not be able to copy it again."

Question 2

I lost my API token - can I view it again?

Accepted Answer

No, a token is shown only once, immediately after it is generated. If you lose it, delete the old token on your profile's API page and generate a new one, then update your application with the new token.

Question 3

How do I revoke a single API token?

Accepted Answer

1) Open your profile and go to the API page. 2) Find the token in the list. 3) Click "Delete" and confirm "Are you sure you want to delete this token?". Once deleted, that token can no longer be used to call the API.

Question 4

Can I revoke all my API tokens at once?

Accepted Answer

Yes. On your profile's API page, click "Revoke all tokens" and confirm "Are you sure you want to delete all tokens?". Every API token you have created stops working; applications using them will need new tokens.

Question 5

How long does an API token stay valid?

Accepted Answer

An API token is valid for 365 days from the moment it is generated, unless you revoke it earlier from your profile's API page. Plan to generate and roll out a replacement token before the year is up.

Question 6

What permissions does an API token have?

Accepted Answer

A token acts as you: it carries the same identity and permissions as your own user account. There are no separate scopes per token. The name you give a token is only a label to help you recognize which application uses it.

Question 7

How do I authenticate my API requests?

Accepted Answer

Per the API documentation: "Each API request must include an 'Authorization' header with the value 'Bearer [token]'", where the token is a personal API token generated from your profile's API page in Deskhero.

Question 8

Where do I find Deskhero's API documentation?

Accepted Answer

Deskhero publishes a developer documentation site at apidocs.deskhero.com, generated from the live API. It documents each public endpoint with its route, HTTP method, required role, inputs and example request and response bodies, and includes guidance on authentication and rate limits.

Question 9

What do Deskhero API URLs look like?

Accepted Answer

API requests go to Deskhero's API host (account.deskhero.com), and most endpoint paths include your workspace name and the API version, for example /api/your-workspace/v1.0/tickets. Endpoints that are not tied to a specific workspace use "sys" in place of the workspace name.

Question 10

Are there rate limits on the Deskhero API?

Accepted Answer

Yes. The API allows 180 requests per 60 seconds, counted per user within a workspace, and the documentation notes that "any excessive or abusive usage may result in the suspension of API access". If you hit the limit, requests are rejected until the window resets, so pace or batch your calls.

Question 11

What can I do with tickets through the API?

Accepted Answer

The ticket endpoints cover the full lifecycle: create and update tickets, list and filter them, fetch a single ticket including its complete conversation, forward a ticket by email, mark it unread, delete it, and export ticket lists to an Excel file. Replies and conversations have their own endpoints as well.

Question 12

Does Deskhero support outbound webhooks to notify my systems of events?

Accepted Answer

No. Deskhero does not currently offer configurable outbound webhooks, so there is no way to register your own endpoint to receive event notifications. To react to changes in your workspace, poll the REST API on a schedule that stays within the rate limit of 180 requests per 60 seconds.

Question 13

Is there an official Deskhero SDK?

Accepted Answer

Deskhero has an official .NET SDK called DeskheroSDK (in beta), built for .NET 8, which wraps the REST API endpoints for accounts, tickets and replies, users and invites, groups, forms, fields, lists, knowledge bases, mailboxes, search and more. It was built for Deskhero's internal use but is free for anyone to use in their own integrations. For other languages, call the REST API directly.

Question 14

Can any user create an API token, or only admins?

Accepted Answer

Any signed-in user can generate and manage their own API tokens from the API page in their profile. Because a token inherits that user's permissions, what a token can do through the API is exactly what that user can do in the app.

Question 15

Is API access included in my Deskhero plan?

Accepted Answer

API access is listed as a feature on the Plans page in Deskhero and is currently included in all plans. The same rate limit of 180 requests per 60 seconds applies regardless of plan.

Question 16

Where can I see the API tokens I have already created?

Accepted Answer

Open your profile and go to the API page: it shows a table of your existing tokens with the label you gave each one, plus buttons to generate a new token or revoke tokens. If you have none yet, the page shows "You have no API tokens yet." with a "Click here to create one" shortcut.

Question 17

Can I reuse Deskhero's look and feel when building a custom integration?

Accepted Answer

Yes. The API documentation encourages it: "We highly encourage the use of our UI library when building custom integrations with Deskhero." The documentation's start page links to a Storybook catalog of Deskhero's UI components that you can browse and reuse.

Question 18

How do I create a personal API token?

Accepted Answer

1) Click your avatar and choose 'My profile', then open the 'API' tab. 2) Click 'Generate API token' and provide the name of the application that will use it. 3) Copy the token right away and store it safely. You will not be able to copy it again. You can delete individual tokens from the list later, and there is also a 'Revoke all tokens' option.

API and webhooks

Did not find what you were looking for?