v3

latestOpenAPI 3.0.32026-07-31135300306.1 KB
issues

Search for issues by a given filter

Currently, the following fields are filterable for issues:

  • created_at (in RFC3339 format). Allowed operators: time_is_after, time_is_before, time_range

  • account_id. Allowed operators: equals, in, not_in, is_set, is_unset

  • ticket_form_id. Allowed operators: equals, in, not_in, is_set, is_unset

  • requester_id. Allowed operators: equals, in, not_in, is_set, is_unset

  • follower_user_id. Allowed operators: equals, in, not_in

  • follower_contact_id. Allowed operators: equals, in, not_in

  • state. Valid values are ["new", "waiting_on_you", "waiting_on_customer", "on_hold", "closed"] or a custom status slug. Allowed operators: equals, in, not_in

  • custom fields (pass in the slug of the custom field)

  • tags (pass in the tag name). Allowed operators: contains, does_not_contain, in, not_in

  • title. Allowed operators: string_contains, string_does_not_contain

  • body_html. Allowed operators: string_contains, string_does_not_contain

  • assignee_id. Allowed operators: equals, in, not_in, is_set, is_unset

  • team_id. Allowed operators: equals, in, not_in

  • issue_type. Valid values are ["conversation", "ticket"]. Allowed operators: equals, in, not_in, is_set, is_unset

  • resolved_at. Allowed operators: time_is_after, time_is_before, time_range

  • latest_message_activity_at. Allowed operators: time_is_after, time_is_before, time_range

  • updated_at (in RFC3339 format). Allowed operators: time_is_after, time_is_before, time_range

  • slack_channel_id (the Slack channel ID the issue was created in). Allowed operators: equals, in, not_in

Rate limit: 20 requests per minute

post/issues/search

Request body

cursorstring

The cursor to use for pagination.

limitinteger

The number of issues to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

search_textstring

Fuzzy text search. Results are intersected with any provided filter.

Response

request_idstring