Fetch Device

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

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

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

Path parameters

deviceIdlongRequired

Response

currentPatientobjectOptional

The patient currently in possession of this device. Null if this device is not currently with a patient.

currentStatusstringOptional

The current status of this device.

deviceEventslist of objectsOptional

An array of the device events for this device.

deviceIdentifierslist of objectsOptional

An array of the device identifiers for this device.

disabledReadingsbooleanOptional

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.

externalIdentifierstringOptional

The external identifier for this device.

idlongOptional

Unique identifier for the device, managed by Impilo.

itemobjectOptional

The manufacturer for this item.

lastHealthCheckstringOptional

Timestamp for the last time Impilo received a signal from this device.

siteobjectOptional

The site to which this device is assigned.

usedbooleanOptional

True if this device is used, false otherwise.

Path parameters

Headers

Response