API ReferenceDevices

List Devices

Returns a paginated list of all devices associated with the customer.

Authentication

Impilo-API-Keystring
API Key authentication via header

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:
sortDescendingbooleanOptional
True if the sort direction should be descending
idlist of longsOptional
Lists only devices with the IDs provided.
externalIdentifierlist of stringsOptional
Lists only devices with the external IDs provided.
identifierTypeenumOptional
The device identifier type of the devices.
identifierlist of stringsOptional
Lists only devices with the device identifiers provided.
statuslist of enumsOptional
The status of the devices.
itemIdlist of longsOptional
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.
manufacturerIdlist of longsOptional
Lists only devices created by the Manufacturer ID provided.
itemSizelist of enumsOptional
Lists only devices of the sizes provided.
Allowed values:
itemClasslist of enumsOptional
Lists only devices of the Classes provided.
readingTypelist of enumsOptional
Lists only devices that support the Reading Types provided.
siteIdlist of longsOptional
The ID of the site.
patientIdlist of longsOptional
The ID of the patient.
patientExternalIdentifierlist of stringsOptional
The external identifier of the patient.
patientEmailstringOptional
The email of the patient.
patientNamestringOptional
The name of the patient.
patientSiteIdlist of longsOptional
The ID of the patient site.

Response

OK
contentlist of objects or null
The content of the page, consisting of a list of objects.
firstboolean or null
True if this is the first page, false otherwise.
lastboolean or null
True if this is the last page, false otherwise.
pageinteger or null
The current page number. The first page has value 1.
sizeinteger or null
The current page size. Default 15, maximum 250.
totalinteger or null
The number of objects matching the request.