Skip to content
All docs pages

API docs

Tickets

Work that comes out of calls.

A ticket tracks a request from a contact until it’s resolved.

  • POST/ticketsCreate a ticket.
  • GET/ticketsList tickets.
  • GET/tickets/{id}One ticket.
  • PATCH/tickets/{id}Update a ticket.
  • DELETE/tickets/{id}Delete a ticket.

Body for POST /tickets

NameDetails
subjectrequiredWhat the ticket is about.
descriptionMore detail.
prioritylow, medium, high or urgent.
statusopen, in_progress, resolved or closed.
contactIdThe contact it's for.
assignedAgentIdWho owns it.
callIdThe call it came from.
slaIdThe SLA that applies.
tagIdsTags to attach.

Filters for GET /tickets

NameDetails
page, limitPaging.
status, prioritySame values as above.
assignedAgentId, unassignedFilter by owner, or only unowned tickets.
contactId, tagIds, slaIdFilter by contact, tags or SLA.
searchFree-text search.