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

200example

1 {
2   "content": [
3     {
4       "assignedTeam": "support",
5       "assignee": {
6         "email": "user_1772@example.com",
7         "firstName": "John",
8         "id": 1772,
9         "lastName": "Doe"
10       },
11       "createdAt": "2024-07-04T00:00:00Z",
12       "createdBy": {
13         "email": "user_1772@example.com",
14         "firstName": "John",
15         "id": 1772,
16         "lastName": "Doe"
17       },
18       "currentStatus": "needsIntake",
19       "customer": {
20         "id": 8,
21         "name": "Customer 8"
22       },
23       "id": 123,
24       "lastUpdated": "2024-07-04T00:00:00Z",
25       "open": true,
26       "patient": {
27         "firstName": "John",
28         "lastName": "Doe",
29         "address": {
30           "city": "Philadelphia",
31           "country": "USA",
32           "lineOne": "1234 Market Street",
33           "state": "PA",
34           "zipCode": "19137",
35           "lineTwo": "Suite 110"
36         },
37         "dateOfBirth": "1987-09-13",
38         "email": "email@example.com",
39         "externalIdentifier": "external-identifier-123",
40         "id": 456,
41         "phoneNumber": "111-222-3333",
42         "sex": "unknown"
43       },
44       "supportTicketEvents": [
45         {
46           "createdAt": "2024-07-04T00:00:00Z",
47           "eventType": "ticketCreated"
48         }
49       ],
50       "supportTicketNotes": [
51         {
52           "createdAt": "2024-07-04T00:00:00Z",
53           "createdBy": {
54             "email": "user_1772@example.com",
55             "firstName": "John",
56             "id": 1772,
57             "lastName": "Doe"
58           },
59           "note": "Example Note."
60         }
61       ],
62       "ticketType": "patientSetup"
63     },
64     {
65       "assignedTeam": "support",
66       "assignee": {
67         "email": "user_1772@example.com",
68         "firstName": "John",
69         "id": 1772,
70         "lastName": "Doe"
71       },
72       "createdAt": "2024-07-04T00:00:00Z",
73       "createdBy": {
74         "email": "user_1772@example.com",
75         "firstName": "John",
76         "id": 1772,
77         "lastName": "Doe"
78       },
79       "currentStatus": "needsIntake",
80       "customer": {
81         "id": 8,
82         "name": "Customer 8"
83       },
84       "id": 124,
85       "lastUpdated": "2024-07-04T00:00:00Z",
86       "open": true,
87       "patient": {
88         "firstName": "John",
89         "lastName": "Doe",
90         "address": {
91           "city": "Philadelphia",
92           "country": "USA",
93           "lineOne": "1234 Market Street",
94           "state": "PA",
95           "zipCode": "19137",
96           "lineTwo": "Suite 110"
97         },
98         "dateOfBirth": "1987-09-13",
99         "email": "email@example.com",
100         "externalIdentifier": "external-identifier-123",
101         "id": 456,
102         "phoneNumber": "111-222-3333",
103         "sex": "unknown"
104       },
105       "supportTicketEvents": [
106         {
107           "createdAt": "2024-07-04T00:00:00Z",
108           "eventType": "ticketCreated"
109         }
110       ],
111       "supportTicketNotes": [
112         {
113           "createdAt": "2024-07-04T00:00:00Z",
114           "createdBy": {
115             "email": "user_1772@example.com",
116             "firstName": "John",
117             "id": 1772,
118             "lastName": "Doe"
119           },
120           "note": "Example Note."
121         }
122       ],
123       "ticketType": "patientSetup"
124     },
125     {
126       "assignedTeam": "support",
127       "assignee": {
128         "email": "user_1772@example.com",
129         "firstName": "John",
130         "id": 1772,
131         "lastName": "Doe"
132       },
133       "createdAt": "2024-07-04T00:00:00Z",
134       "createdBy": {
135         "email": "user_1772@example.com",
136         "firstName": "John",
137         "id": 1772,
138         "lastName": "Doe"
139       },
140       "currentStatus": "needsIntake",
141       "customer": {
142         "id": 8,
143         "name": "Customer 8"
144       },
145       "id": 125,
146       "lastUpdated": "2024-07-04T00:00:00Z",
147       "open": true,
148       "patient": {
149         "firstName": "John",
150         "lastName": "Doe",
151         "address": {
152           "city": "Philadelphia",
153           "country": "USA",
154           "lineOne": "1234 Market Street",
155           "state": "PA",
156           "zipCode": "19137",
157           "lineTwo": "Suite 110"
158         },
159         "dateOfBirth": "1987-09-13",
160         "email": "email@example.com",
161         "externalIdentifier": "external-identifier-123",
162         "id": 456,
163         "phoneNumber": "111-222-3333",
164         "sex": "unknown"
165       },
166       "supportTicketEvents": [
167         {
168           "createdAt": "2024-07-04T00:00:00Z",
169           "eventType": "ticketCreated"
170         }
171       ],
172       "supportTicketNotes": [
173         {
174           "createdAt": "2024-07-04T00:00:00Z",
175           "createdBy": {
176             "email": "user_1772@example.com",
177             "firstName": "John",
178             "id": 1772,
179             "lastName": "Doe"
180           },
181           "note": "Example Note."
182         }
183       ],
184       "ticketType": "patientSetup"
185     },
186     {
187       "assignedTeam": "support",
188       "assignee": {
189         "email": "user_1772@example.com",
190         "firstName": "John",
191         "id": 1772,
192         "lastName": "Doe"
193       },
194       "createdAt": "2024-07-04T00:00:00Z",
195       "createdBy": {
196         "email": "user_1772@example.com",
197         "firstName": "John",
198         "id": 1772,
199         "lastName": "Doe"
200       },
201       "currentStatus": "needsIntake",
202       "customer": {
203         "id": 8,
204         "name": "Customer 8"
205       },
206       "id": 126,
207       "lastUpdated": "2024-07-04T00:00:00Z",
208       "open": true,
209       "patient": {
210         "firstName": "John",
211         "lastName": "Doe",
212         "address": {
213           "city": "Philadelphia",
214           "country": "USA",
215           "lineOne": "1234 Market Street",
216           "state": "PA",
217           "zipCode": "19137",
218           "lineTwo": "Suite 110"
219         },
220         "dateOfBirth": "1987-09-13",
221         "email": "email@example.com",
222         "externalIdentifier": "external-identifier-123",
223         "id": 456,
224         "phoneNumber": "111-222-3333",
225         "sex": "unknown"
226       },
227       "supportTicketEvents": [
228         {
229           "createdAt": "2024-07-04T00:00:00Z",
230           "eventType": "ticketCreated"
231         }
232       ],
233       "supportTicketNotes": [
234         {
235           "createdAt": "2024-07-04T00:00:00Z",
236           "createdBy": {
237             "email": "user_1772@example.com",
238             "firstName": "John",
239             "id": 1772,
240             "lastName": "Doe"
241           },
242           "note": "Example Note."
243         }
244       ],
245       "ticketType": "patientSetup"
246     },
247     {
248       "assignedTeam": "support",
249       "assignee": {
250         "email": "user_1772@example.com",
251         "firstName": "John",
252         "id": 1772,
253         "lastName": "Doe"
254       },
255       "createdAt": "2024-07-04T00:00:00Z",
256       "createdBy": {
257         "email": "user_1772@example.com",
258         "firstName": "John",
259         "id": 1772,
260         "lastName": "Doe"
261       },
262       "currentStatus": "needsIntake",
263       "customer": {
264         "id": 8,
265         "name": "Customer 8"
266       },
267       "id": 127,
268       "lastUpdated": "2024-07-04T00:00:00Z",
269       "open": true,
270       "patient": {
271         "firstName": "John",
272         "lastName": "Doe",
273         "address": {
274           "city": "Philadelphia",
275           "country": "USA",
276           "lineOne": "1234 Market Street",
277           "state": "PA",
278           "zipCode": "19137",
279           "lineTwo": "Suite 110"
280         },
281         "dateOfBirth": "1987-09-13",
282         "email": "email@example.com",
283         "externalIdentifier": "external-identifier-123",
284         "id": 456,
285         "phoneNumber": "111-222-3333",
286         "sex": "unknown"
287       },
288       "supportTicketEvents": [
289         {
290           "createdAt": "2024-07-04T00:00:00Z",
291           "eventType": "ticketCreated"
292         }
293       ],
294       "supportTicketNotes": [
295         {
296           "createdAt": "2024-07-04T00:00:00Z",
297           "createdBy": {
298             "email": "user_1772@example.com",
299             "firstName": "John",
300             "id": 1772,
301             "lastName": "Doe"
302           },
303           "note": "Example Note."
304         }
305       ],
306       "ticketType": "patientSetup"
307     }
308   ],
309   "first": true,
310   "last": false,
311   "page": 1,
312   "size": 5,
313   "total": 10
314 }

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 objects or null

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

firstboolean or null

True if this is the first page, false otherwise.

lastboolean or null

True if this is the last page, false otherwise.

pageinteger or null

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

sizeinteger or null

The current page size. Default 15, maximum 250.

totalinteger or null

The number of objects matching the request.

Headers

Query parameters

Response