Tickets

Tickets are the central work records and the parent of mail messages, appointments, and time records.

Ticket fields and identifiers

The {ticket} path parameter accepts a record ID or external identifier. Identifiers are opaque strings assigned by the source system. Tickets also participate in the provider custom-field system: import provider fields for the ticket model and send the resulting grouped additional data.

Retrieve ticket.schema.json for the current native request fields and constraints.

GET/api/v1/tickets

List tickets

Required scope: tickets:read. The standard list supports shared filters, relations, limit, and opt-in perPage pagination.

QUERY/api/v1/tickets

Query tickets

Required scope: tickets:read. The query supports table-layout fields and ticket filters. Pagination belongs in the JSON body, for example page and per_page.

POST/api/v1/tickets

Create a ticket

Required scope: tickets:write. Send fields accepted by the current ticket request schema. Relationships such as contact, address, users, device, contract, and contract option must reference records visible to the tenant.

GET/api/v1/tickets/{ticket}

Get a ticket

Required scope: tickets:read.

PATCH/api/v1/tickets/{ticket}

Update a ticket

Required scope: tickets:write. PUT is also registered.

DELETE/api/v1/tickets/{ticket}

Delete a ticket

Required scope: tickets:write. Returns 204 No Content on success.

Was this page helpful?