API - About the Mojo Helpdesk REST API

The Mojo Helpdesk API enables 3rd party developers to create, edit, update, delete, and export tickets, users and comments. It supports building custom workflows and integrations with other tools or systems.

Accessing and using the API requires technical resources and developer experience. API documentation and examples are available here: https://developer.mojohelpdesk.com

API keys

An API key is a credential tied to an agent's account. Each agent manages their own keys, and each agent can hold two:

Key What it can do
Read-write Full API access - read and write.
Read-only Retrieve data only. Any create, update, or delete request is rejected.

A key inherits the permissions of the agent who owns it, including queue access. For an integration that needs to see the whole help desk, generate the key from an admin or owner account.

Generate or copy a key

  1. Click your avatar (upper right) → My profile.
  2. Scroll to Dev settings → API keys.
  3. Next to Read-write or Read-only, click Generate, then use the reveal and copy buttons.

Note: you can only see and manage your own keys. Admins cannot view or generate a key for another agent - each agent generates their own.

Expiry, rotation, and revocation

  • Expiry is optional. Leave the date blank and the key never expires; set one and the key stops working after that date.
  • Rotate generates a new value for the same key. The old value stops working immediately.
  • Revoke deletes the key entirely.
  • Rotating or revoking an API key does not log the agent out, and changing your Mojo password does not change your API keys. (API keys are revoked when an account is recovered through the forgot-password email link, or when an admin forces a password reset.)

Read-only keys

A read-only key may only make GET requests. Any POST, PUT, PATCH, or DELETE returns 401 with This API key is read-only and cannot perform write operations. This includes the export endpoints, which are POST requests because they queue a job and email a file.

API keys are available to agents only. Contacts cannot have one.

How to view current API usage and limits

Go to Account administration > Overview to view current account usage.

Scroll down the page, and expand Quotas to view current plan limits and usage.