List Devices

Returns a paginated list of all devices associated with the customer.

Query parameters

pageintegerOptional

The page number of the content returned.

sizeintegerOptional

The size of the page of content returned.

sortenumOptional

The attribute to sort on

Allowed values:

sortDescendingbooleanOptional

True if the sort direction should be descending

idlist of longsOptional

Lists only devices with the IDs provided.

externalIdentifierlist of stringsOptional

Lists only devices with the external IDs provided.

identifierTypeenumOptional

The device identifier type of the devices.

Allowed values:

identifierlist of stringsOptional

Lists only devices with the device identifiers provided.

statuslist of enumsOptional

The status of the devices.

itemIdlist of longsOptional

Lists only devices with the provided Item ID type.

itemNamestringOptional

The name of the item.

itemModelstringOptional

The model of the item.

itemSkustringOptional

The SKU of the item.

manufacturerIdlist of longsOptional

Lists only devices created by the Manufacturer ID provided.

itemSizelist of enumsOptional

Lists only devices of the sizes provided.

Allowed values:

itemClasslist of enumsOptional

Lists only devices of the Classes provided.

readingTypelist of enumsOptional

Lists only devices that support the Reading Types provided.

siteIdlist of longsOptional

The ID of the site.

patientIdlist of longsOptional

The ID of the patient.

patientExternalIdentifierlist of stringsOptional

The external identifier of the patient.

patientEmailstringOptional

The email of the patient.

patientNamestringOptional

The name of the patient.

patientSiteIdlist of longsOptional

The ID of the patient site.

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.

1	{
2	"content": [
3	{
4	"currentPatient": {
5	"firstName": "John",
6	"lastName": "Doe",
7	"address": {
8	"city": "foo",
9	"country": "foo",
10	"lineOne": "foo",
11	"state": "foo",
12	"zipCode": "foo",
13	"lineThree": "foo",
14	"lineTwo": "foo",
15	"note": "foo"
16	},
17	"archived": true,
18	"dateOfBirth": "1980-01-01",
19	"email": "john.doe@example.com",
20	"enrolled": true,
21	"externalIdentifier": "1234abcd",
22	"id": 1,
23	"phoneNumber": "+1234567890",
24	"sex": "unknown",
25	"site": {
26	"active": true,
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	"id": 1,
38	"name": "foo",
39	"phoneNumber": "foo"
40	}
41	},
42	"currentStatus": "foo",
43	"deviceEvents": [
44	{
45	"eventTimestamp": "foo",
46	"type": "foo"
47	}
48	],
49	"deviceIdentifiers": [
50	{
51	"type": "foo",
52	"value": "foo"
53	}
54	],
55	"disabledReadings": false,
56	"externalIdentifier": "1d23-4567-89ab-cdef",
57	"id": 1,
58	"item": {
59	"id": 1,
60	"manufacturer": {
61	"id": 1,
62	"name": "foo"
63	},
64	"model": "foo",
65	"name": "foo",
66	"orderable": true,
67	"sku": "foo"
68	},
69	"lastHealthCheck": "2023-10-01T12:00:00Z",
70	"site": {
71	"active": true,
72	"address": {
73	"city": "foo",
74	"country": "foo",
75	"lineOne": "foo",
76	"state": "foo",
77	"zipCode": "foo",
78	"lineThree": "foo",
79	"lineTwo": "foo",
80	"note": "foo"
81	},
82	"id": 1,
83	"name": "foo",
84	"phoneNumber": "foo"
85	},
86	"used": true
87	}
88	],
89	"first": true,
90	"last": true,
91	"page": 42,
92	"size": 42,
93	"total": 42
94	}

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

Headers

Query parameters

Response