listDevicesResponse

List Devices

associateDeviceRequest

Associate Device

disassociateDeviceRequest

Disassociate Device

This endpoint validates that a Device Identifier exists and returns the Device upon matching. On failure, it indicates that the Identifier is not valid.

validateDeviceResponse

Validate Device

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

fetchDeviceResponse

Fetch Device

updateDeviceRequest

Update Device

Devices

listItemsResponse

List Items

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

fetchItemResponse

Fetch Item

Items

listKitsResponse

List Kits

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

fetchKitResponse

Fetch Kit

Kits

listManufacturersResponse

List Manufacturers

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

fetchManufacturerResponse

Fetch Manufacturer

Manufacturers

List Orders

existing-patient-order

new-patient-order

site-order

Create Order

Fetch Order

Void Order

Orders

Retrieves a paginated list of patients. Optional parameters allow specifying the page number and page size.

List Patients

Create Patient

Fetch Patient By Email

Fetches details of a specific patient by their unique ID.

Fetch Patient

Update Patient

Patch Patient

Patients

List Sites

Create Site

Returns the site specified by the ID in the URL path.

Fetch Site

Update Site

Partially update the site specified by the ID in the URL path with a new site object.

Patch Site

Sites

This endpoint retrieves a paginated list of V3 webhooks that the associated Customer is subscribed to.

ListWebhooksResponse

List Webhooks

WebhookResponseExample

Create Webhook

Gets your Webhook Secret if it exists. Otherwise returns an error.

Fetch Webhook Secret

Create Webhook Secret

Delete Webhook Secret

Update Webhook Secret

Retrieves a paginated list of webhook logs that record historical attempts to send webhook payloads to a customer's servers. This endpoint allows filtering logs based on webhook type, creation timestamp range, retry attempts range, last response status, last retry timestamp range, and pagination settings. It is useful for auditing and debugging purposes.

The number of the page to retrieve (1 based)

List Webhook Logs

This endpoint retrieves a particular Webhook of a customer by the ID provided in the path.

fetchWebhooksResponse

Fetch Webhook

This endpoint deletes the specified Webhook from the customer's subscriptions.

Delete Webhook

updateWebhookRequestExample

Patch Webhook

This endpoint is used to trigger retries for stored failed webhook requests.

Trigger Retries

Webhooks

listReadingResponse

List Blood Glucose Readings

Exports blood glucose readings for a specified patient within a given date range as either an Excel spreadsheet or a CSV file. This endpoint allows clients to specify a patient ID, and optional start and end dates to filter the readings by date. If no patient ID is provided, readings for all patients may be exported depending on the implementation. The 'excel' parameter determines the format of the export: if true, the data is returned in Excel format; otherwise, it is returned as CSV. The response is directly streamed to the client as either 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' for Excel or 'text/csv' for CSV format.

The end date for filtering blood glucose readings. Only readings before this date will be included.

Determines the format of the export: if true, the data is returned in Excel format; otherwise, it is returned as CSV.

The ID of the patient whose blood glucose readings are to be exported. If not provided, readings for all patients may be exported.

The start date for filtering blood glucose readings. Only readings after or equal to this date will be included.

Export Blood Glucose Readings

This endpoint returns a specific blood glucose reading based on the reading identifier provided in the path.

fetchReadingResponse

Fetch Blood Glucose Reading

Readings - Blood Glucose

Retrieves a paginated list of blood oxygen readings from the Impilo platform. Optional parameters can be used to filter the results by page number, page size, patient ID, external ID, start timestamp, and end timestamp.

List Blood Oxygen Readings

Exports blood oxygen readings for a specified patient within a given date range as either an Excel spreadsheet or a CSV file. This endpoint facilitates the retrieval of blood oxygen data by allowing the specification of a patient ID and optional start and end dates to narrow down the readings. If no patient ID is specified, the service may return readings for all patients, contingent on the service's implementation details. The 'excel' parameter controls the output format: if set to true, the data is delivered in Excel format; if false, it is delivered in CSV format. The data is streamed directly to the client and can be consumed in the specified format.

The end date for filtering blood oxygen readings. Only readings before this date will be included.

The ID of the patient whose blood oxygen readings are to be exported. If not provided, readings for all patients may be exported.

The start date for filtering blood oxygen readings. Only readings after or equal to this date will be included.

Export Blood Oxygen Readings

Fetches a specific Impilo blood oxygen reading by its ID.

Fetch Blood Oxygen Reading

Readings - Blood Oxygen

Retrieves a paginated list of blood pressure readings from the Impilo platform. Optional parameters can be used to filter the results by page number, page size, patient ID, external ID, start timestamp, and end timestamp.

List Blood Pressure Readings

Provides an export of blood pressure readings for a specified patient over a selected date range, available in either Excel or CSV format. Users can specify a patient ID to retrieve data for a particular individual, or leave the parameter empty to potentially export data for all patients, depending on service implementation. Optional start and end date parameters allow for filtering the data by the desired timeframe. The 'excel' flag determines the format of the output; when true, the data is exported in Excel format, otherwise, it is provided as a CSV file. The response consists of a direct stream of the chosen data format to the client.

The end date for filtering blood pressure readings. Only readings before this date will be included.

The ID of the patient whose blood pressure readings are to be exported. If not provided, readings for all patients may be exported.

The start date for filtering blood pressure readings. Only readings after or equal to this date will be included.

Export Blood Pressure Readings

Fetches a specific Impilo blood pressure reading by its ID.

Fetch Blood Pressure Reading

Readings - Blood Pressure

Retrieves a paginated list of temperature readings from the Impilo platform. Optional parameters can be used to filter the results by page number, page size, patient ID, external ID, start timestamp, and end timestamp.

List Temperature Readings

Facilitates the export of temperature readings for a specified patient within a chosen date range, in either Excel or CSV format. This endpoint allows the selection of a patient ID for targeted data retrieval, or can provide readings for all patients if no specific ID is provided, subject to service implementation. The start and end dates are optional and can be used to filter the readings to a specific period. The 'excel' parameter decides the output format: setting this to true returns the data in Excel format, while false yields CSV format. The endpoint streams the output directly to the client in the specified format.

The end date for filtering temperature readings. Only readings before this date will be included.

The ID of the patient whose temperature readings are to be exported. If not provided, readings for all patients may be exported.

The start date for filtering temperature readings. Only readings after or equal to this date will be included.

Export Temperature Readings

Fetches a specific Impilo temperature reading by its ID.

Fetch Temperature Reading

Readings - Temperature

Retrieves a paginated list of weight readings from the Impilo platform. Optional parameters can be used to filter the results by page number, page size, patient ID, external ID, start timestamp, and end timestamp.

List Weight Readings

Exports weight readings for a specified patient over a selected date range, available in either Excel or CSV format. This endpoint allows the specification of a patient ID, enabling the retrieval of weight data for an individual patient. Alternatively, if no patient ID is provided, it may export readings for all patients, dependent on the implementation details of the service. Users can also specify start and end dates to filter the export to a specific timeframe. The 'excel' parameter dictates the format of the output; if set to true, the readings are exported in Excel format, otherwise in CSV format

The end date for filtering weight readings. Only readings before this date will be included.

The ID of the patient whose weight readings are to be exported. If not provided, readings for all patients may be exported.

The start date for filtering weight readings. Only readings after or equal to this date will be included.

Export Weight Readings

Fetches a specific Impilo weight reading by its ID.

Fetch Weight Reading

Readings - Weight

Trigger Blood Glucose Webhook

Trigger Blood Oxygen Webhook

Trigger Blood Pressure Webhook

Trigger Device Association Created

Trigger Device Association Removed

Order Status Full Webhook

Trigger Order Status Webhook

Trigger Weight Webhook

Receive Test

Receive Bg Test

Receive Bp Test

Receive Order Test

Receive Weight Test

Tests

Represents a physical address, including information such as street lines, city, state, zip code, country, and an optional note for additional details.

Address

AssociateDeviceRequest

The ID of the device to be associated. Either this value or a Device Identifier are required to identify the Device to be (dis)associated.

The ID of the patient to have the Device associated to. Either this value or a Patient External Identifier are required to identify who should be (dis)associated with the device.

The Identifier, such as a Serial Number, of the device to be (dis)associated. Either this value or a Device Id are required to identify the Device to be (dis)associated.

The External Identifier of the patient to have the Device (dis)associated to. Either this value or a Patient Id are required to identify who should be (dis)associated with the device.

This page describes Impilo's blood glucose reading model.

BloodGlucoseReading

The timestamp at which the reading was taken.

True if the reading value was entered manually, false otherwise.

True if the reading was taken before a meal, false otherwise.

True if the reading was taken after a meal, false otherwise.

This page describes Impilo's blood oxygen reading model.

BloodOxygenReading

The blood oxygen (spo2) measurement value.

This page describes Impilo's blood pressure reading model.

BloodPressureReading

A device is an instance of an item. Impilo creates device records for items that are serialized, i.e., items where each individual unit is identified by a serial number, IMEI, or other identifier.

Device

Unique identifier for the device, managed by Impilo.

True if this device is used, false otherwise.

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

The site to which this device is assigned.

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

An array of the device identifiers for this device.

An array of the device events for this device.

The webhook payload sent when a Device is either Associated or Disassociated with a patient.

DeviceAssociationWebhookPayload

The Patient that the device was either associated with or disassociated from.

The Device that was associated to or disassociated from the provided Patient.

The type of association that was performed -- either 'associate' or 'disassociate'.

A device event represents a significant activity or occurrence detected by the device. Impilo tracks these events to provide insights into device usage and operational status.

DeviceEvent

The timestamp when the Device Event was created.

DeviceIdentifier

The value of the Device Identifier, based on it's type.

Instant

An item is any of the supplies handled by Impilo. Examples include medical devices like a blood pressure monitor or weight scale, but the term 'item' also refers to non-medical supplies like AAA batteries and package inserts. A customer catalog is a subset of all items supported by Impilo. This is set during onboarding and may be modified by your account manager at any time. A customer may view the items in their catalog.

Item

Unique identifier for the item, managed by Impilo.

The manufacturer-assigned model for this item.

A kit is a named collection of items that can be ordered as one unit.

True if the kit is archived, false otherwise.

KitItem

A manufacturer is a supplier of an item. Every item has exactly one manufacturer.

Manufacturer

Unique identifier for the manufacturer, managed by Impilo.

Order

An array of order ids specified by the client

The patient receiving the order. Exactly one of patient or site must be not null.

The site receiving the order. Exactly one of patient or site must be not null.

Array of items on the order. At least one of orderItems or orderKits must be not null.

Array of order kits on the order. At least one of orderItems or orderKits must be not null.

1	curl -X POST https://app.impiloplatform.com/api/v3/site \
2	-H "Impilo-API-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"id": 1,
3	"name": "name",
4	"active": true,
5	"address": {
6	"lineOne": "lineOne",
7	"lineTwo": "lineTwo",
8	"lineThree": "lineThree",
9	"city": "city",
10	"state": "state",
11	"zipCode": "zipCode",
12	"country": "country",
13	"note": "note"
14	}
15	}

Get Started

Guides

API Reference

Resources

Create Site

Request

Response