List Devices

GET

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: itemNameitemModelitemSkudeviceId

sortDescendingbooleanOptional

True if the sort direction should be descending

idlongOptional

Lists only devices with the IDs provided.

externalIdentifierstringOptional

Lists only devices with the external IDs provided.

identifierTypeenumOptional

The device identifier type of the devices.

Allowed values: simCardNumbermacAddressiccidserialimei

identifierstringOptional

Lists only devices with the device identifiers provided.

statusenumOptional

The status of the devices.

itemIdlongOptional

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.

manufacturerIdlongOptional

Lists only devices created by the Manufacturer ID provided.

itemSizeenumOptional

Lists only devices of the sizes provided.

Allowed values: standardsmalllargeextraLargemedium

itemClassenumOptional

Lists only devices of the Classes provided.

readingTypeenumOptional

Lists only devices that support the Reading Types provided.

siteIdlongOptional

The ID of the site.

patientIdlongOptional

The ID of the patient.

patientExternalIdentifierstringOptional

The external identifier of the patient.

patientEmailstringOptional

The email of the patient.

patientNamestringOptional

The name of the patient.

patientSiteIdlongOptional

The ID of the patient site.

Response

This endpoint returns an object.

contentlist of objectsOptional

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

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.

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

GET

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

200listDevicesResponseExample

1 {
2   "content": [
3     {
4       "id": 599,
5       "item": {
6         "id": 791,
7         "manufacturer": {
8           "id": 2,
9           "name": "Custom Manufacturer"
10         },
11         "name": "Blood Pressure Monitor",
12         "model": "iBloodPressureMonitor123",
13         "sku": "0000001"
14       },
15       "currentStatus": "withPatient",
16       "used": true,
17       "currentPatient": {
18         "firstName": "John",
19         "lastName": "Doe",
20         "id": 456,
21         "externalIdentifier": "external-identifier-123",
22         "dateOfBirth": "1987-09-13",
23         "email": "email@example.com",
24         "phoneNumber": "111-222-3333",
25         "archived": true,
26         "address": {
27           "lineOne": "1234 Market Street",
28           "city": "Philadelphia",
29           "state": "PA",
30           "zipCode": "19137",
31           "country": "USA",
32           "lineTwo": "Suite 110"
33         },
34         "sex": "unknown"
35       },
36       "site": {
37         "id": 1
38       },
39       "lastHealthCheck": "lastHealthCheck",
40       "deviceIdentifiers": [
41         {
42           "type": "imei",
43           "value": "354833969951611"
44         },
45         {
46           "type": "serial",
47           "value": "A44-A0623930"
48         },
49         {
50           "type": "macAddress",
51           "value": "f51da43314fc"
52         }
53       ],
54       "deviceEvents": [
55         {}
56       ],
57       "externalIdentifier": "externalIdentifier",
58       "disabledReadings": false
59     },
60     {
61       "id": 600,
62       "item": {
63         "id": 791,
64         "manufacturer": {
65           "id": 2,
66           "name": "Custom Manufacturer"
67         },
68         "name": "Blood Pressure Monitor",
69         "model": "iBloodPressureMonitor123",
70         "sku": "0000001"
71       },
72       "currentStatus": "withPatient",
73       "used": true,
74       "currentPatient": {
75         "firstName": "John",
76         "lastName": "Doe",
77         "id": 456,
78         "externalIdentifier": "external-identifier-123",
79         "dateOfBirth": "1987-09-13",
80         "email": "email@example.com",
81         "phoneNumber": "111-222-3333",
82         "archived": true,
83         "address": {
84           "lineOne": "1234 Market Street",
85           "city": "Philadelphia",
86           "state": "PA",
87           "zipCode": "19137",
88           "country": "USA",
89           "lineTwo": "Suite 110"
90         },
91         "sex": "unknown"
92       },
93       "site": {
94         "id": 1
95       },
96       "lastHealthCheck": "lastHealthCheck",
97       "deviceIdentifiers": [
98         {
99           "type": "imei",
100           "value": "354833969951611"
101         },
102         {
103           "type": "serial",
104           "value": "A44-A0623930"
105         },
106         {
107           "type": "macAddress",
108           "value": "f51da43314fc"
109         }
110       ],
111       "deviceEvents": [
112         {}
113       ],
114       "externalIdentifier": "externalIdentifier",
115       "disabledReadings": false
116     }
117   ],
118   "page": 1,
119   "size": 2,
120   "total": 4,
121   "first": true,
122   "last": false
123 }

Built with

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

1	{
2	"content": [
3	{
4	"id": 599,
5	"item": {
6	"id": 791,
7	"manufacturer": {
8	"id": 2,
9	"name": "Custom Manufacturer"
10	},
11	"name": "Blood Pressure Monitor",
12	"model": "iBloodPressureMonitor123",
13	"sku": "0000001"
14	},
15	"currentStatus": "withPatient",
16	"used": true,
17	"currentPatient": {
18	"firstName": "John",
19	"lastName": "Doe",
20	"id": 456,
21	"externalIdentifier": "external-identifier-123",
22	"dateOfBirth": "1987-09-13",
23	"email": "email@example.com",
24	"phoneNumber": "111-222-3333",
25	"archived": true,
26	"address": {
27	"lineOne": "1234 Market Street",
28	"city": "Philadelphia",
29	"state": "PA",
30	"zipCode": "19137",
31	"country": "USA",
32	"lineTwo": "Suite 110"
33	},
34	"sex": "unknown"
35	},
36	"site": {
37	"id": 1
38	},
39	"lastHealthCheck": "lastHealthCheck",
40	"deviceIdentifiers": [
41	{
42	"type": "imei",
43	"value": "354833969951611"
44	},
45	{
46	"type": "serial",
47	"value": "A44-A0623930"
48	},
49	{
50	"type": "macAddress",
51	"value": "f51da43314fc"
52	}
53	],
54	"deviceEvents": [
55	{}
56	],
57	"externalIdentifier": "externalIdentifier",
58	"disabledReadings": false
59	},
60	{
61	"id": 600,
62	"item": {
63	"id": 791,
64	"manufacturer": {
65	"id": 2,
66	"name": "Custom Manufacturer"
67	},
68	"name": "Blood Pressure Monitor",
69	"model": "iBloodPressureMonitor123",
70	"sku": "0000001"
71	},
72	"currentStatus": "withPatient",
73	"used": true,
74	"currentPatient": {
75	"firstName": "John",
76	"lastName": "Doe",
77	"id": 456,
78	"externalIdentifier": "external-identifier-123",
79	"dateOfBirth": "1987-09-13",
80	"email": "email@example.com",
81	"phoneNumber": "111-222-3333",
82	"archived": true,
83	"address": {
84	"lineOne": "1234 Market Street",
85	"city": "Philadelphia",
86	"state": "PA",
87	"zipCode": "19137",
88	"country": "USA",
89	"lineTwo": "Suite 110"
90	},
91	"sex": "unknown"
92	},
93	"site": {
94	"id": 1
95	},
96	"lastHealthCheck": "lastHealthCheck",
97	"deviceIdentifiers": [
98	{
99	"type": "imei",
100	"value": "354833969951611"
101	},
102	{
103	"type": "serial",
104	"value": "A44-A0623930"
105	},
106	{
107	"type": "macAddress",
108	"value": "f51da43314fc"
109	}
110	],
111	"deviceEvents": [
112	{}
113	],
114	"externalIdentifier": "externalIdentifier",
115	"disabledReadings": false
116	}
117	],
118	"page": 1,
119	"size": 2,
120	"total": 4,
121	"first": true,
122	"last": false
123	}