Skip to main content
GET
/
tickets
/
search
Searching tickets
curl --request GET \
  --url https://api.qminder.com/v1/tickets/search \
  --header 'X-Qminder-REST-API-Key: <api-key>'
"{\n  \"statusCode\": 200,\n  \"data\": [\n    {\n      \"id\": \"51999102\",\n      \"status\": \"SERVED\",\n      \"source\": \"MANUAL\",\n      \"line\": 88100,\n      \"firstName\": \"Jane\",\n      \"lastName\": \"Doe\",\n      \"orderAfter\": \"2015-04-29T12:29:40.701Z\",\n      \"created\": {\n        \"date\": \"2016-04-29T12:29:40.701Z\"\n      },\n      \"called\": {\n        \"date\": \"2016-05-05T14:05:29Z\",\n        \"caller\": 15144,\n        \"desk\": 3\n      },\n      \"served\": {\n        \"date\": \"2016-05-05T14:05:34Z\"\n      },\n      \"assigned\": {\n        \"assigner\": 15100,\n        \"assignee\": 15144\n      },\n      \"extra\": [\n        {\n          \"title\": \"Notes\",\n          \"value\": \"assistance required\"\n        }\n      ],\n      \"labels\": [\n        {\n          \"value\": \"VIP\",\n          \"color\": \"FF00FF\"\n        }\n      ],\n      \"interactions\": [\n        {\n          \"start\": \"2016-05-05T14:05:29Z\",\n          \"end\": \"2016-05-05T14:05:34Z\",\n          \"line\": 88100,\n          \"user\": 15144\n        }\n      ],\n      \"messages\": [\n        {\n          \"created\": {\n            \"date\": \"2017-06-15T18:43:41Z\"\n          },\n          \"body\": \"Hello Jane! You are now in the queue. We will let you know when it's your turn.\",\n          \"type\": \"OUTGOING\",\n          \"status\": \"DELIVERED\"\n        }\n      ]\n    }\n  ]\n}"

Authorizations

​
X-Qminder-REST-API-Key
string
header
default:yourbusinessapikey
required

Query Parameters

​
location
integer<int32>

Search tickets only in the given Location.

​
line
integer<int32>
​
status
string

Search tickets with only the given status. Multiple statuses can be searched by separating them with a comma. "NEW" will return tickets that are in queue, and have not been called. "CALLED" will return tickets that are currently being served. "SERVED" will return tickets that have been served. "CANCELLED_BY_CLERK" will return tickets that have been removed from queue.

​
caller
string

Search tickets that have been called by the given user ID. Both "CALLED" and "SERVED" tickets will be returned, unless status is also specified.

​
minCreated
string<date-time>

Search tickets which have been created after the given timestamp. The timestamp can be in ISO 8601 format, eg "2020-05-03T00:00:00Z". Alternatively, the timestamp can be a Unix timestamp, eg 1588767798.

​
maxCreated
string<date-time>

Search tickets which have been created before the given timestamp. The timestamp can be in ISO 8601 format, eg "2020-05-03T00:00:00Z". Alternatively, the timestamp can be a Unix timestamp, eg 1588767798.

​
minCalled
string<date-time>

Search tickets which have been called after the given timestamp. The timestamp can be in ISO 8601 format, eg "2020-05-03T00:00:00Z". Alternatively, the timestamp can be a Unix timestamp, eg 1588767798.

​
maxCalled
string<date-time>

Search tickets which have been called before the given timestamp. The timestamp can be in ISO 8601 format, eg "2020-05-03T00:00:00Z". Alternatively, the timestamp can be a Unix timestamp, eg 1588767798.

​
limit
integer<int32>

Limit search results to the specified amount of tickets. With a limit of 100, only the 100 first results will be returned. The limit has to be between 1 and 20000.

​
order
string

Order search results according to a ticket parameter. Order is specified using two words in one string, for example "id ASC". Valid order directions: ASC, DESC Valid ordering parameters: id, created, called, served

​
responseScope
string

Include additional data in the search results. Use multiple response scopes by separating them with a comma. Valid response scopes are: "MESSAGES" - include SMS messages with the response "INTERACTIONS" - include interaction data with the response "CONNECTED_TICKETS" - include connected tickets (other visits of the same person)

Response

200 - application/json

200

​
statusCode
integer
default:0
Example:

200

​
data
object[]