v1

latestOpenAPI 3.0.02026-08-061770538.1 KB
Ticket

Returns a paginated list of Tickets

Required permission: Tickets - List/Search Single-Customer Users can only access own tickets.

get/tickets

Query parameters

customer_idinteger

Any Ticket with customer_id equal to the parameter.

contact_idinteger

Any Ticket with contact_id equal to the parameter.

numberstring

Any Ticket with number equal to the parameter.

resolved_afterstring

Returns Tickets resolved after the date. Example "2019-01-23".

created_afterstring

Returns Tickets created after the date. Example "2019-02-25".

since_updated_atstring

Returns Tickets updated after the date. Example "2019-02-25".

statusstring

Any Ticket with status equal to the parameter. Examples "New", "In Progress", "Resolved", "Invoiced", "Waiting for Parts", "Waiting on Customer", "Scheduled", "Customer Reply", "Not Closed".

querystring

Search query

user_idinteger

Any Ticket assigned to a User ID

mineboolean

Any Ticket assigned to the current user

ticket_search_idinteger

Returns results of a Ticket Search

pageinteger

Returns provided page of results, each 'page' contains 25 results

comment_formatstring

Returns comments in the specified format. Allowed values: 'plaintext', 'richtext', 'original'. Defaults to 'plaintext'.

all_commentsboolean

(DEPRICATED PARAM) When set to true, includes all ticket comments in the resposne, when set to false, only the initial comment is returned. Defaults to true. In near future(31 Mar, 2026) params will disappear and endpoint returns only first comment

asset_namestring

Returns only Tickets linked (via assets) to assets whose name matches the provided value (case-insensitive partial match). Optional. Combine with customer_id to scope the asset search to a single customer; without customer_id the search spans all matching customers in the authenticated account. Combine with asset_serial to AND both filters against the same asset match set.

asset_serialstring

Returns only Tickets linked (via assets) to assets whose serial number is exactly the provided value (exact match). Optional. Combine with asset_name to AND both filters against the same asset match set.

Response

successful