What can the Deskwoot REST API do?

The Deskwoot REST API gives you programmatic access to your support data, so you can read and create conversations, manage contacts, send and fetch messages, and wire Deskwoot into your own tools and scripts. It is an Enterprise feature, and you authenticate every request with a token you create under Settings > API tokens.

What can you do with the API?

The REST API covers the day-to-day objects in your helpdesk. With the right token scopes you can:

• Conversations: list, read, create, and update conversations, and change their status or assignment.
• Messages: fetch the messages in a conversation and post new replies or private notes.
• Contacts: read, create, and update the people who write in, including their attributes.
• Reports: every number of the Reports page (volume, first response and resolution times, CSAT) per agent, team, inbox, channel, label, status, priority, day or week, with filters you can combine and any date range, plus every conversation and CSAT response as rows or CSV.

This makes the API a good fit for syncing tickets with an internal system, building a custom dashboard, automating routine updates, or feeding conversation data into another tool.

Which plan includes the REST API?

The REST API is an Enterprise feature, and API tokens can only be created on a paid Enterprise plan. The 7-day Enterprise trial that every new account starts on does not include API tokens. If you are on a lower plan and need API access, you will need to be on Enterprise.

How do I get a token?

Tokens are created and managed under Settings > API tokens. Give each token a clear name, grant only the scopes the integration needs, and copy it as soon as it is generated, since the full value may not be shown again. See the API tokens guide for the full walkthrough, including the base URL and how to pass the token in the authorization header.

What if I want an AI agent instead of writing code?

If your goal is to let an external AI agent operate the helpdesk rather than to write your own integration, the MCP server may be a better fit. It exposes a defined set of tools to an MCP-aware agent through a scoped bot token. Like the REST API it is an Enterprise feature, but unlike API tokens it also works during the 7-day Enterprise trial.

Frequently asked questions