Skip to main content

Search Tickets

POST 
/tickets/search

Using filters, search through tickets in your organization.

This API call is only available to organizations that have purchased Closed Loop Follow Up. Organizations not enrolled will receive a 403 with the error code TIK_1.1.
This API call will paginate up to a maximum of 10,000 tickets.

To return more than this, use the Search Tickets endpoint with filters that split the tickets into sections of less than 10,000 each.

CriterionJSON SyntaxAccepted Comparisons
name{"query":{"queryType" :"name","comparison": "eq","value": "Ticket Name"}}[contains, does_not_contain, exists, does_not_exist, eq, neq ]
key{ "query": { "queryType" :"key", "comparison": "eq", "value": "T-123" } }[ eq, neq, exists, does_not_exist ]
ownerId{ "query": { "queryType" :"ownerId", "comparison": "eq", "value": "UR_123" } }[ eq, neq, exists, does_not_exist ]
status{ "query": { "queryType" :"status", "comparison": "eq", "value": 0 } }[ eq, neq, exists, does_not_exist ]
priority{ "query": { "queryType" :"priority", "comparison": "eq", "value": 0 } }[ eq, neq, exists, does_not_exist ]
createdAt{ "query": { "queryType" :"createdAt", "comparison": "gt", "value": "2019-07-03T10:27:19.000Z" } }[ eq, gt, gte, lt, lte ]
updatedAt{ "query": { "queryType" :"updatedAt", "comparison": "gt", "value": "2019-07-03T10:27:19.000Z" } }[ eq, gt, gte, lt, lte ]
closedAt{ "query": { "queryType" :"closedAt", "comparison": "eq", "value": "2019-07-03T10:27:19.000Z" } }[ eq, gt, gte, lt, lte ]
keyValue{ "query": { "queryType" :"keyValue", "comparison": "exists", "key": "country" }[ contains, does_not_contain, exists, does_not_exist, eq, neq ]

Compound Query​

{
     "query": {
        "queryType": "compound",
        "comparison": "and",
        "children": [
              {
                "queryType" :"createdAt",
                "comparison": "gt",
                "value": "2019-07-03T14:42:29.000Z"
            },
            {
                "queryType" :"name",
                "comparison": "eq",
                "value": ["New Ticket"]
            },
            {
                "queryType" :"status",
                "comparison": "eq",
                "value": [0]
            }
        ]
     }
}
This API call is only available to organizations that have purchased Closed Loop Follow Up. Organizations not enrolled will receive a 403 with the error code TIK_1.1.
This API call will paginate up to a maximum of 10,000 tickets.

To return more than this, use the Search Tickets endpoint with filters that split the tickets into sections of less than 10,000 each.

The "contain" comparison only matches against full words.

Request​

Responses​

Ticket Search Response.