Devices

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

idintegerOptional

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.

itemIdintegerOptional

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.

manufacturerIdintegerOptional

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.

siteIdintegerOptional

The ID of the site.

patientIdintegerOptional

The ID of the patient.

patientExternalIdentifierstringOptional

The external identifier of the patient.

patientEmailstringOptional

The email of the patient.

patientNamestringOptional

The name of the patient.

patientSiteIdintegerOptional

The ID of the patient site.

Response

This endpoint returns an object

content

list of objectsOptional

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

page

integerOptional

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

size

integerOptional

The current page size. Default 15, maximum 250.

total

integerOptional

The number of objects matching the request.

first

booleanOptional

True if this is the first page, false otherwise.

last

booleanOptional

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>"

200Retrieved

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         "id": 456,
19         "externalIdentifier": "external-identifier-123",
20         "firstName": "John",
21         "lastName": "Doe",
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           "lineTwo": "Suite 110",
29           "city": "Philadelphia",
30           "state": "PA",
31           "zipCode": "19137",
32           "country": "USA"
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         "id": 456,
76         "externalIdentifier": "external-identifier-123",
77         "firstName": "John",
78         "lastName": "Doe",
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           "lineTwo": "Suite 110",
86           "city": "Philadelphia",
87           "state": "PA",
88           "zipCode": "19137",
89           "country": "USA"
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	"id": 456,
19	"externalIdentifier": "external-identifier-123",
20	"firstName": "John",
21	"lastName": "Doe",
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	"lineTwo": "Suite 110",
29	"city": "Philadelphia",
30	"state": "PA",
31	"zipCode": "19137",
32	"country": "USA"
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	"id": 456,
76	"externalIdentifier": "external-identifier-123",
77	"firstName": "John",
78	"lastName": "Doe",
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	"lineTwo": "Suite 110",
86	"city": "Philadelphia",
87	"state": "PA",
88	"zipCode": "19137",
89	"country": "USA"
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	}