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.
Criterion | JSON Syntax | Accepted 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
containcomparison only matches against full words.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
offset | number | The start position for pagination | |
pageSize | number | The 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
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"result":{"elements":[{"key":"T-0","name":"\u003cstring\u003e","ownerId":"UR_nFCyhfYhUTO","status":"\u003cinteger\u003e","priority":"\u003cinteger\u003e","followUpDetailsSurveyId":"\u003cstring\u003e","followUpDetailsResponseId":"\u003cstring\u003e"},{"key":"T-4400","name":"\u003cstring\u003e","ownerId":"UR_3BdbDZBSj0g0r52","status":"\u003cinteger\u003e","priority":"\u003cinteger\u003e","followUpDetailsSurveyId":"\u003cstring\u003e","followUpDetailsResponseId":"\u003cstring\u003e"}],"links":{"prev":{"href":"\u003cstring\u003e"},"next":{"href":"\u003cstring\u003e"}}},"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}