ad855d921ee9

latestOpenAPI 3.0.32026-08-14137304312.9 KB
issues

Search for issues by a given filter

Filterable fields and their allowed operators:

FieldAllowed operators
created_attime_is_after, time_is_before, time_range
account_idequals, in, not_in, is_set, is_unset
ticket_form_idequals, in, not_in, is_set, is_unset
requester_idequals, in, not_in, is_set, is_unset
follower_user_idequals, in, not_in
follower_contact_idequals, in, not_in
stateequals, in, not_in
tagscontains, does_not_contain, in, not_in
titlestring_contains, string_does_not_contain
body_htmlstring_contains, string_does_not_contain
assignee_idequals, in, not_in, is_set, is_unset
team_idequals, in, not_in
issue_typeequals, in, not_in, is_set, is_unset
resolved_attime_is_after, time_is_before, time_range
latest_message_activity_attime_is_after, time_is_before, time_range
updated_attime_is_after, time_is_before, time_range
slack_channel_idequals, in, not_in

Timestamp values use RFC3339 format. Standard state values are new, waiting_on_you, waiting_on_customer, on_hold, and closed; custom status slugs are also supported. issue_type values are conversation and ticket.

For tag filters, pass the tag name. For custom fields, pass the field slug as field. slack_channel_id identifies the Slack channel where the issue was created.

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

Example response

{
  "data": [
    {
      "state": "new"
    }
  ]
}