Listing tickets (all)

This method allows you to return all tickets which are stored in your database.




This method can be accessed by account tokens and user tokens where the associated user has access to the reporting UI.

Supported Parameters

  • page - the page number to return tickets for (optional, defaults to 1)
  • sort_by - the name of a field to sort results by (optional, must be one of updated_at, created_at, reference, subject, last_update_posted_at, reply_due_at, resolution_due_at, first_response_time, first_resolution_time, resolution_time)
  • order - the direction you wish to sort results (optional, must be 'asc' or 'desc', defaults to 'asc')

Returned Data

This method returns paginated data with up to 20 tickets returned on each request. The request includes details of the paginations which has been performed.

Ticket information is returned in the records array and contains all the properties shown on the getting ticket properties page however excludes any ticket updates which are posted.

Example JSON

  "pagination": {
    "page": 1,
    "offset": 0,
    "per_page": 20,
    "pages": 2,
    "total_records": 33
  "records": [
      ... ticket information is included here (as shown on the ticket properties page)...

Proudly powered by Katapult. Running on 100% renewable energy.