Skip to content
On this page

REST API reference

REST API v1

Read and change tickets, customers, conversations, licenses and knowledge with an API key or an OAuth access token, and receive HMAC-signed webhooks when things change.

Base URL

Every endpoint lives under one base URL. Requests and responses are JSON over HTTPS.

Base URL
https://zono.support/api/v1

Your first request

Send a token as Authorization: Bearer <token>: an API key for your own scripts, or an OAuth 2.0 access token for an app that acts for a user (see authentication). GET /me tells you which user, team and access the token has.

Check your tokencurl
curl https://zono.support/api/v1/me \
  -H "Authorization: Bearer $ZONO_TOKEN" \
  -H "Accept: application/json"

OpenAPI and Postman

The whole API, including webhook payload schemas and the OAuth 2.0 security scheme, is described in an OpenAPI 3.1 document you can load into Swagger UI, Insomnia or an SDK generator. The Postman collection has every endpoint with example requests: set its token variable to your API key.

Endpoint groups

Account1 endpointCheck which user, team and access a token has.Tickets11 endpointsChanges run through the same code as the app: notifications, SLA clocks, automation rules and webhooks all fire.Customers5 endpointsAdmin and owner tokens only, as in the app: other roles get 403. Email addresses and external ids are unique per team. Passwords and tokens are never accepted or returned. Changing an email clears its verification, so the customer must verify the new address before using the portal.Licenses2 endpointsPurchase codes and license keys stored for the team's customers, and live checks against the marketplace. Admin and owner tokens only, as they reveal customer data. Verifying never stores or changes anything, so a read-only token is enough.Conversations10 endpointsInbox conversations from every channel, limited to what the token's user sees in the Inbox, and what an agent does there: reply or add an internal note, assign, resolve, reopen, mark as spam, mark read and show a live chat visitor they are typing. Changes behave exactly as in the Inbox: a promoted conversation is replied to, assigned, closed and reopened through its ticket.Reference data8 endpointsRead-only lists to map names to the ids tickets use.Knowledge base2 endpointsArticles (read only). Admin and owner tokens also see drafts; other roles see published articles only.Webhook subscriptions5 endpointsREST Hooks for no-code tools (Zapier, n8n, Make): subscribe a URL to events when a trigger is switched on and unsubscribe when it is switched off. Deliveries are signed and retried like any webhook. Owner and admin tokens only (other roles get 403); subscriptions belong to the token (an API key, or the OAuth app's connection), so revoking the key or disconnecting the app removes them. Endpoints added under Settings > Webhooks are not listed here and cannot be changed through the API.

Guides