Fetch Support Ticket By Id

GET

/api/v3/support-ticket/:id

GET

/api/v3/support-ticket/:id

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

Try it

200fetchSupportTicketByIdExample

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

Retrieves a support ticket by the ID from the Impilo platform.

Path parameters

idlongRequired

The ID of the Support Ticket to fetch.

Response

assignedTeamenumOptional

The team that’s assigned this Support Ticket, if any.

Allowed values:

assigneeobjectOptional

The EndUser assigned to this Support Ticket, if any.

createdAtstringOptionalformat: "date-time"

The timestamp when the Support Ticket was created.

createdByobjectOptional

The creator of this Support Ticket.

currentStatusenumOptional

The current status of the Support Ticket.

Allowed values:

customerobjectOptional

The Customer to whom this Support Ticket belongs.

deviceobjectOptional

The Device that the Support Ticket involves, if applicable.

idlongOptional

The ID of the Support Ticket.

lastUpdatedstringOptionalformat: "date-time"

The most recent time that this Support Ticket was updated in some form.

openbooleanOptional

Whether or not the ticket is considered open or closed.

orderobjectOptional

The Order that the Support Ticket involves, if applicable.

patientobjectOptional

The Patient that the Support Ticket involves, if applicable.

siteobjectOptional

The Site that the Support Ticket involves, if applicable.

supportTicketEventslist of objectsOptional

A list of all SupportTicketEvents attached to this Support Ticket.

supportTicketNoteslist of objectsOptional

A list of all SupportTicketNotes attached to this Support Ticket.

ticketTypeenumOptional

The type of Support Ticket.

Path parameters

Headers

Response