Search Tickets

POST {{baseUrl}}/tickets/search?offset=0&pageSize=50

Using filters, search through tickets in your organization. <!--From Readme--> <!-- theme: info -->

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, doesnotcontain, exists, doesnotexist, eq, neq ]
key{ query: { queryType :key, comparison: eq, value: T-123 } }[ eq, neq, exists, doesnotexist ]
ownerId{ query: { queryType :ownerId, comparison: eq, value: UR_123 } }[ eq, neq, exists, doesnotexist ]
status{ query: { queryType :status, comparison: eq, value: 0 } }[ eq, neq, exists, doesnotexist ]
priority{ query: { queryType :priority, comparison: eq, value: 0 } }[ eq, neq, exists, doesnotexist ]
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, doesnotcontain, exists, doesnotexist, eq, neq ]

Compund 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 Params

KeyDatatypeRequiredDescription
offsetnumberThe start position for pagination
pageSizenumberThe maximum number of tickets to return per request

Request Body

{"query"=>{"comparison"=>"and", "queryType"=>"status", "value"=>["<string>", "<string>"], "key"=>"<string>", "children"=>[{"comparison"=>"gte", "queryType"=>"priority", "value"=>["<string>", "<string>"], "key"=>"<string>"}]}, "sort"=>{"orderBy"=>"<string>", "direction"=>"asc"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;result&quot;:{&quot;elements&quot;:[{&quot;key&quot;:&quot;T-0&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;ownerId&quot;:&quot;UR_nFCyhfYhUTO&quot;,&quot;status&quot;:&quot;\u003cinteger\u003e&quot;,&quot;priority&quot;:&quot;\u003cinteger\u003e&quot;,&quot;followUpDetailsSurveyId&quot;:&quot;\u003cstring\u003e&quot;,&quot;followUpDetailsResponseId&quot;:&quot;\u003cstring\u003e&quot;},{&quot;key&quot;:&quot;T-4400&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;ownerId&quot;:&quot;UR_3BdbDZBSj0g0r52&quot;,&quot;status&quot;:&quot;\u003cinteger\u003e&quot;,&quot;priority&quot;:&quot;\u003cinteger\u003e&quot;,&quot;followUpDetailsSurveyId&quot;:&quot;\u003cstring\u003e&quot;,&quot;followUpDetailsResponseId&quot;:&quot;\u003cstring\u003e&quot;}],&quot;links&quot;:{&quot;prev&quot;:{&quot;href&quot;:&quot;\u003cstring\u003e&quot;},&quot;next&quot;:{&quot;href&quot;:&quot;\u003cstring\u003e&quot;}}},&quot;meta&quot;:{&quot;httpStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;requestId&quot;:&quot;\u003cstring\u003e&quot;,&quot;notice&quot;:&quot;\u003cstring\u003e&quot;}}