issues

Search for issues by a given filter

Changed on

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
customer_portal_visibleequals, in, not_in
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
issue_is_issue_groupequals, in, not_in
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
workspace_emailequals, in, not_in, is_set, is_unset
reopenedequals, 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. workspace_email identifies the email address connected to the Pylon workspace through which the issue's email conversation is routed. customer_portal_visible values are true and false; issue groups are never visible in the customer portal, so they always match false. reopened values are true and false; it is a sticky flag set the first time an issue is reopened after being resolved, and it records no timestamp.

Rate limit: 120 requests per minute

post/issues/search

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/issues/search
  • Auth
    HTTP bearer

Request body

cursorstring

The cursor to use for pagination.

limitinteger

The number of issues to fetch. Defaults to 100. Must be between 1 and 1000.

search_textstring

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

Example request

{
  "filter": {
    "subfilters": [
      {
        "field": "state",
        "operator": "equals",
        "value": "new"
      }
    ]
  }
}

Response

request_idstring required

Example response

{
  "data": [
    {
      "business_hours_time_in_status_seconds": {
        "new": 120,
        "waiting_on_customer": 1800
      },
      "custom_fields": {
        "priority": {
          "value": "high"
        }
      },
      "state": "new",
      "time_in_status_seconds": {
        "new": 120,
        "waiting_on_customer": 3600
      },
      "workspace_phone_number": "+14155551234"
    }
  ]
}

Changes

    • info

      added the new optional request property

    • info

      added the new not enum value to the request property /

    • info

      added the new time_is_in_last enum value to the request property /

    • info

      added the new time_is_in_next enum value to the request property /

    • info

      added the new time_is_not_in_last enum value to the request property /

    • info

      added the new time_is_not_in_next enum value to the request property /