v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Triggers

List Ticket Triggers

Lists all ticket triggers for the current account.

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

  • Agents

Sideloads

The following sideloads are supported. The usage sideloads are only supported on the Support Professional or Suite Growth plan or above.

NameWill sideload
app_installationThe app installation that requires each trigger, if present
permissionsThe permissions for each trigger
usage_1hThe number of times each trigger has been used in the past hour
usage_24hThe number of times each trigger has been used in the past day
usage_7dThe number of times each trigger has been used in the past week
usage_30dThe number of times each trigger has been used in the past thirty days
get/api/v2/triggers

Query parameters

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

activeboolean

Filter by active triggers if true or inactive triggers if false

sortstring

Cursor-based pagination only. Possible values are "alphabetical", "created_at", "updated_at", or "position".

sort_bystring

Offset pagination only. Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", or "usage_7d". Defaults to "position"

sort_orderstring

One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others

category_idstring

Filter triggers by category ID

Response

Success response

countinteger
next_pagestring nullable
previous_pagestring nullable