GET /api/v2/tickets

List Tickets

Servers

Query parameters

Name Type Required Description
page No

Pagination parameter. Supports both traditional offset and cursor-based pagination:

  • Traditional: ?page=2 (integer page number)
  • Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before)

These are mutually exclusive - use one format or the other, not both.

external_id String No

Lists tickets by external id. External ids don't have to be unique for each ticket. As a result, the request may return multiple tickets with the same external id.

sort_order String No

Sort order. Defaults to "asc"

Valid values:

  • "desc"
  • "asc"
include String No

Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading.

start_time Integer No

Unix epoch time to filter tickets. Only tickets created or updated after this time are returned. Example: ?start_time=1332034771

per_page Integer No

Number of records to return per page.

Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.

sort String No

Field to sort results by. Prefix with - for descending order.

When used with cursor pagination, this determines the cursor ordering.

Example: ?sort=name or ?sort=-created_at

support_type_scope String No

Lists tickets by support type. Possible values are "all", "agent", or "ai_agent". Defaults to "agent"

sort_by String No

Sort by

Valid values:

  • "deleted_at"
  • "id"
  • "subject"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.