Devices

Fetch Device

GET
This endpoint returns the Device specified by ID in the URL path.

Path parameters

deviceIdintegerRequired

Response

This endpoint returns an object
id
integerOptional
Unique identifier for the device, managed by Impilo.
item
objectOptional
The manufacturer for this item.
currentStatus
stringOptional
The current status of this device.
used
booleanOptional
True if this device is used, false otherwise.
currentPatient
objectOptional
The patient currently in possession of this device. Null if this device is not currently with a patient.
site
objectOptional
The site to which this device is assigned.
lastHealthCheck
stringOptional
Timestamp for the last time Impilo received a signal from this device.
deviceIdentifiers
list of objectsOptional
An array of the device identifiers for this device.
deviceEvents
list of objectsOptional
An array of the device events for this device.
externalIdentifier
stringOptional
The external identifier for this device.
disabledReadings
booleanOptional
True if readings from this device are disabled, false otherwise. If true, Impilo will not save or process readings from this device. Webhooks and alerts will not be triggered for readings taken on this device.
GET
1curl https://app.impiloplatform.com/api/v3/device/1 \
2 -H "Impilo-API-Key: <apiKey>"
200Retrieved
1{
2 "id": 599,
3 "item": {
4 "id": 791,
5 "manufacturer": {
6 "id": 2,
7 "name": "Custom Manufacturer"
8 },
9 "name": "Blood Pressure Monitor",
10 "model": "iBloodPressureMonitor123",
11 "sku": "0000001"
12 },
13 "currentStatus": "withPatient",
14 "used": true,
15 "currentPatient": {
16 "id": 456,
17 "externalIdentifier": "external-identifier-123",
18 "firstName": "John",
19 "lastName": "Doe",
20 "dateOfBirth": "1987-09-13",
21 "email": "email@example.com",
22 "phoneNumber": "111-222-3333",
23 "archived": true,
24 "address": {
25 "lineOne": "1234 Market Street",
26 "lineTwo": "Suite 110",
27 "lineThree": "lineThree",
28 "city": "Philadelphia",
29 "state": "PA",
30 "zipCode": "19137",
31 "country": "USA",
32 "note": "note"
33 },
34 "site": {
35 "id": 1,
36 "name": "name",
37 "active": true
38 },
39 "enrolled": true,
40 "sex": "unknown"
41 },
42 "site": {
43 "id": 1,
44 "name": "name",
45 "active": true,
46 "address": {
47 "lineOne": "lineOne",
48 "lineTwo": "lineTwo",
49 "lineThree": "lineThree",
50 "city": "city",
51 "state": "state",
52 "zipCode": "zipCode",
53 "country": "country",
54 "note": "note"
55 }
56 },
57 "lastHealthCheck": "lastHealthCheck",
58 "deviceIdentifiers": [
59 {
60 "type": "imei",
61 "value": "354833969951611"
62 },
63 {
64 "type": "serial",
65 "value": "A44-A0623930"
66 },
67 {
68 "type": "macAddress",
69 "value": "f51da43314fc"
70 }
71 ],
72 "deviceEvents": [
73 {
74 "type": "type",
75 "eventTimestamp": "eventTimestamp"
76 }
77 ],
78 "externalIdentifier": "externalIdentifier",
79 "disabledReadings": false
80}