API reference
Support API
Support tickets from inside the product: raise one, reply to it, close it, rate the outcome, and read the categories to choose from.
Endpoints
8 operations, each with its parameters, schemas and an example request on its own page.
- get/api/supportList tickets — This workspace's tickets.
- post/api/supportCreate a ticket — Raises a ticket.
- get/api/support/categoriesList ticket categories — The list a customer picks from, with what each one means.
- get/api/support/statsTicket statistics
- get/api/support/{ticket_id}Get a ticket — One ticket and its thread. Internal notes are excluded by the query.
- post/api/support/{ticket_id}/closeClose a ticket — Lets the customer close their own ticket.
- post/api/support/{ticket_id}/rateRate a ticket — The customer's verdict, accepted only on a finished ticket.
- post/api/support/{ticket_id}/replyReply to a ticket — Adds a customer message.
Authentication
Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.
Objects returned
The models these endpoints send back, with every field. Open one to read it.
Message2 fields
messagestringrequiredokbooleanDefault: true
Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.