List Support Tickets

GET

/api/v3/support-ticket

GET

/api/v3/support-ticket

1 curl https://app.impiloplatform.com/api/v3/support-ticket \
2      -H "Impilo-API-Key: <Impilo-API-Key>"

Try it

200listSupportTicketsExample

1 {
2   "content": [
3     {
4       "assignedTeam": "engineering",
5       "assignee": {
6         "email": "foo",
7         "firstName": "foo",
8         "id": 42,
9         "lastName": "foo"
10       },
11       "createdAt": "foo",
12       "createdBy": {
13         "email": "foo",
14         "firstName": "foo",
15         "id": 42,
16         "lastName": "foo"
17       },
18       "currentStatus": "needsIntake",
19       "customer": {
20         "id": 42,
21         "name": "foo"
22       },
23       "device": {
24         "currentPatient": {
25           "firstName": "John",
26           "lastName": "Doe",
27           "address": {
28             "city": "foo",
29             "country": "foo",
30             "lineOne": "foo",
31             "state": "foo",
32             "zipCode": "foo",
33             "lineThree": "foo",
34             "lineTwo": "foo",
35             "note": "foo"
36           },
37           "archived": true,
38           "dateOfBirth": "1980-01-01",
39           "email": "john.doe@example.com",
40           "enrolled": true,
41           "externalIdentifier": "1234abcd",
42           "id": 1,
43           "phoneNumber": "+1234567890",
44           "sex": "unknown",
45           "site": {
46             "active": true,
47             "address": {
48               "city": "foo",
49               "country": "foo",
50               "lineOne": "foo",
51               "state": "foo",
52               "zipCode": "foo",
53               "lineThree": "foo",
54               "lineTwo": "foo",
55               "note": "foo"
56             },
57             "id": 1,
58             "name": "foo",
59             "phoneNumber": "foo"
60           }
61         },
62         "currentStatus": "foo",
63         "deviceEvents": [
64           {
65             "eventTimestamp": "foo",
66             "type": "foo"
67           }
68         ],
69         "deviceIdentifiers": [
70           {
71             "type": "foo",
72             "value": "foo"
73           }
74         ],
75         "disabledReadings": false,
76         "externalIdentifier": "1d23-4567-89ab-cdef",
77         "id": 1,
78         "item": {
79           "id": 1,
80           "manufacturer": {
81             "id": 1,
82             "name": "foo"
83           },
84           "model": "foo",
85           "name": "foo",
86           "orderable": true,
87           "sku": "foo"
88         },
89         "lastHealthCheck": "2023-10-01T12:00:00Z",
90         "site": {
91           "active": true,
92           "address": {
93             "city": "foo",
94             "country": "foo",
95             "lineOne": "foo",
96             "state": "foo",
97             "zipCode": "foo",
98             "lineThree": "foo",
99             "lineTwo": "foo",
100             "note": "foo"
101           },
102           "id": 1,
103           "name": "foo",
104           "phoneNumber": "foo"
105         },
106         "used": true
107       },
108       "id": 42,
109       "lastUpdated": "foo",
110       "open": true,
111       "order": {
112         "currentStatus": "reconfirmAddress",
113         "devices": [
114           {
115             "currentPatient": {
116               "firstName": "John",
117               "lastName": "Doe",
118               "address": {
119                 "city": "foo",
120                 "country": "foo",
121                 "lineOne": "foo",
122                 "state": "foo",
123                 "zipCode": "foo",
124                 "lineThree": "foo",
125                 "lineTwo": "foo",
126                 "note": "foo"
127               },
128               "archived": true,
129               "dateOfBirth": "1980-01-01",
130               "email": "john.doe@example.com",
131               "enrolled": true,
132               "externalIdentifier": "1234abcd",
133               "id": 1,
134               "phoneNumber": "+1234567890",
135               "sex": "unknown",
136               "site": {
137                 "active": true,
138                 "address": {
139                   "city": "foo",
140                   "country": "foo",
141                   "lineOne": "foo",
142                   "state": "foo",
143                   "zipCode": "foo",
144                   "lineThree": "foo",
145                   "lineTwo": "foo",
146                   "note": "foo"
147                 },
148                 "id": 1,
149                 "name": "foo",
150                 "phoneNumber": "foo"
151               }
152             },
153             "currentStatus": "foo",
154             "deviceEvents": [
155               {
156                 "eventTimestamp": "foo",
157                 "type": "foo"
158               }
159             ],
160             "deviceIdentifiers": [
161               {
162                 "type": "foo",
163                 "value": "foo"
164               }
165             ],
166             "disabledReadings": false,
167             "externalIdentifier": "1d23-4567-89ab-cdef",
168             "id": 1,
169             "item": {
170               "id": 1,
171               "manufacturer": {
172                 "id": 1,
173                 "name": "foo"
174               },
175               "model": "foo",
176               "name": "foo",
177               "orderable": true,
178               "sku": "foo"
179             },
180             "lastHealthCheck": "2023-10-01T12:00:00Z",
181             "site": {
182               "active": true,
183               "address": {
184                 "city": "foo",
185                 "country": "foo",
186                 "lineOne": "foo",
187                 "state": "foo",
188                 "zipCode": "foo",
189                 "lineThree": "foo",
190                 "lineTwo": "foo",
191                 "note": "foo"
192               },
193               "id": 1,
194               "name": "foo",
195               "phoneNumber": "foo"
196             },
197             "used": true
198           }
199         ],
200         "externalOrderIds": [
201           "foo"
202         ],
203         "id": 42,
204         "orderEvents": [
205           {
206             "eventTimestamp": "foo",
207             "name": "foo"
208           }
209         ],
210         "orderItems": [
211           {
212             "count": 42,
213             "item": {
214               "id": 1,
215               "manufacturer": {
216                 "id": 1,
217                 "name": "foo"
218               },
219               "model": "foo",
220               "name": "foo",
221               "orderable": true,
222               "sku": "foo"
223             }
224           }
225         ],
226         "orderKits": [
227           {
228             "count": 42,
229             "kit": {
230               "archived": true,
231               "id": 42,
232               "kitItems": [
233                 {
234                   "count": 42,
235                   "item": {
236                     "id": 1,
237                     "manufacturer": {
238                       "id": 1,
239                       "name": "foo"
240                     },
241                     "model": "foo",
242                     "name": "foo",
243                     "orderable": true,
244                     "sku": "foo"
245                   }
246                 }
247               ],
248               "name": "foo"
249             }
250           }
251         ],
252         "orderNotes": [
253           {
254             "createdAt": "foo",
255             "createdBy": {
256               "email": "foo",
257               "firstName": "foo",
258               "id": 42,
259               "lastName": "foo"
260             },
261             "note": "foo"
262           }
263         ],
264         "packedKits": [
265           {
266             "devices": [
267               {
268                 "currentPatient": {
269                   "firstName": "John",
270                   "lastName": "Doe",
271                   "address": {
272                     "city": "foo",
273                     "country": "foo",
274                     "lineOne": "foo",
275                     "state": "foo",
276                     "zipCode": "foo",
277                     "lineThree": "foo",
278                     "lineTwo": "foo",
279                     "note": "foo"
280                   },
281                   "archived": true,
282                   "dateOfBirth": "1980-01-01",
283                   "email": "john.doe@example.com",
284                   "enrolled": true,
285                   "externalIdentifier": "1234abcd",
286                   "id": 1,
287                   "phoneNumber": "+1234567890",
288                   "sex": "unknown",
289                   "site": {
290                     "active": true,
291                     "address": {
292                       "city": "foo",
293                       "country": "foo",
294                       "lineOne": "foo",
295                       "state": "foo",
296                       "zipCode": "foo",
297                       "lineThree": "foo",
298                       "lineTwo": "foo",
299                       "note": "foo"
300                     },
301                     "id": 1,
302                     "name": "foo",
303                     "phoneNumber": "foo"
304                   }
305                 },
306                 "currentStatus": "foo",
307                 "deviceEvents": [
308                   {
309                     "eventTimestamp": "foo",
310                     "type": "foo"
311                   }
312                 ],
313                 "deviceIdentifiers": [
314                   {
315                     "type": "foo",
316                     "value": "foo"
317                   }
318                 ],
319                 "disabledReadings": false,
320                 "externalIdentifier": "1d23-4567-89ab-cdef",
321                 "id": 1,
322                 "item": {
323                   "id": 1,
324                   "manufacturer": {
325                     "id": 1,
326                     "name": "foo"
327                   },
328                   "model": "foo",
329                   "name": "foo",
330                   "orderable": true,
331                   "sku": "foo"
332                 },
333                 "lastHealthCheck": "2023-10-01T12:00:00Z",
334                 "site": {
335                   "active": true,
336                   "address": {
337                     "city": "foo",
338                     "country": "foo",
339                     "lineOne": "foo",
340                     "state": "foo",
341                     "zipCode": "foo",
342                     "lineThree": "foo",
343                     "lineTwo": "foo",
344                     "note": "foo"
345                   },
346                   "id": 1,
347                   "name": "foo",
348                   "phoneNumber": "foo"
349                 },
350                 "used": true
351               }
352             ],
353             "kit": {
354               "archived": true,
355               "id": 42,
356               "kitItems": [
357                 {
358                   "count": 42,
359                   "item": {
360                     "id": 1,
361                     "manufacturer": {
362                       "id": 1,
363                       "name": "foo"
364                     },
365                     "model": "foo",
366                     "name": "foo",
367                     "orderable": true,
368                     "sku": "foo"
369                   }
370                 }
371               ],
372               "name": "foo"
373             }
374           }
375         ],
376         "patient": {
377           "firstName": "John",
378           "lastName": "Doe",
379           "address": {
380             "city": "foo",
381             "country": "foo",
382             "lineOne": "foo",
383             "state": "foo",
384             "zipCode": "foo",
385             "lineThree": "foo",
386             "lineTwo": "foo",
387             "note": "foo"
388           },
389           "archived": true,
390           "dateOfBirth": "1980-01-01",
391           "email": "john.doe@example.com",
392           "enrolled": true,
393           "externalIdentifier": "1234abcd",
394           "id": 1,
395           "phoneNumber": "+1234567890",
396           "sex": "unknown",
397           "site": {
398             "active": true,
399             "address": {
400               "city": "foo",
401               "country": "foo",
402               "lineOne": "foo",
403               "state": "foo",
404               "zipCode": "foo",
405               "lineThree": "foo",
406               "lineTwo": "foo",
407               "note": "foo"
408             },
409             "id": 1,
410             "name": "foo",
411             "phoneNumber": "foo"
412           }
413         },
414         "shippingOption": "standard",
415         "site": {
416           "active": true,
417           "address": {
418             "city": "foo",
419             "country": "foo",
420             "lineOne": "foo",
421             "state": "foo",
422             "zipCode": "foo",
423             "lineThree": "foo",
424             "lineTwo": "foo",
425             "note": "foo"
426           },
427           "id": 1,
428           "name": "foo",
429           "phoneNumber": "foo"
430         },
431         "trackingNumbers": [
432           {
433             "carrier": "usps",
434             "value": "foo"
435           }
436         ]
437       },
438       "patient": {
439         "firstName": "John",
440         "lastName": "Doe",
441         "address": {
442           "city": "foo",
443           "country": "foo",
444           "lineOne": "foo",
445           "state": "foo",
446           "zipCode": "foo",
447           "lineThree": "foo",
448           "lineTwo": "foo",
449           "note": "foo"
450         },
451         "archived": true,
452         "dateOfBirth": "1980-01-01",
453         "email": "john.doe@example.com",
454         "enrolled": true,
455         "externalIdentifier": "1234abcd",
456         "id": 1,
457         "phoneNumber": "+1234567890",
458         "sex": "unknown",
459         "site": {
460           "active": true,
461           "address": {
462             "city": "foo",
463             "country": "foo",
464             "lineOne": "foo",
465             "state": "foo",
466             "zipCode": "foo",
467             "lineThree": "foo",
468             "lineTwo": "foo",
469             "note": "foo"
470           },
471           "id": 1,
472           "name": "foo",
473           "phoneNumber": "foo"
474         }
475       },
476       "site": {
477         "active": true,
478         "address": {
479           "city": "foo",
480           "country": "foo",
481           "lineOne": "foo",
482           "state": "foo",
483           "zipCode": "foo",
484           "lineThree": "foo",
485           "lineTwo": "foo",
486           "note": "foo"
487         },
488         "id": 1,
489         "name": "foo",
490         "phoneNumber": "foo"
491       },
492       "supportTicketEvents": [
493         {
494           "createdAt": "foo",
495           "eventType": "other"
496         }
497       ],
498       "supportTicketNotes": [
499         {
500           "createdAt": "foo",
501           "createdBy": {
502             "email": "foo",
503             "firstName": "foo",
504             "id": 42,
505             "lastName": "foo"
506           },
507           "note": "foo"
508         }
509       ],
510       "ticketType": "addressConfirmation"
511     }
512   ],
513   "first": true,
514   "last": true,
515   "page": 42,
516   "size": 42,
517   "total": 42
518 }

Retrieves a paginated list of support tickets from the Impilo platform.

Query parameters

pageintegerOptionalDefaults to 1

The page number of the content returned.

sizeintegerOptionalDefaults to 15

The page size of the content returned.

ticketTypeenumOptional

The support ticket type to filter by.

assigneeEmailstringOptional

The email address of the individual asssigned a support ticket.

patientExternalIdentifierstringOptional

The external identifier of the patient associated with a support itcket.

patientIdlongOptional

The id of the patient associated with a support ticket.

createdAtstringOptionalformat: "date-time"

The time after which a support ticket was created.

updatedAtstringOptionalformat: "date-time"

The time after which a support ticket was last updated.

openbooleanOptional

Whether or not a support ticket is considered closed or not.

Response

contentlist of objectsOptional

The content of the page, consisting of a list of objects.

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

pageintegerOptional

The current page number. The first page has value 1.

sizeintegerOptional

The current page size. Default 15, maximum 250.

totalintegerOptional

The number of objects matching the request.

Headers

Query parameters

Response