API Reference
API ReferenceChangelogLog In
API Reference

Fetch all sensors.Response conforms to the JSON API spec https://jsonapi.org/.Responses are limited to 1,000 sensors after which pagination will take place.

Response

FieldDescriptionData Type
dataArray of hardware sensor models.Array of Hardware Sensor Models (see below)
includedIncluded relationships.Building
Floor
linksPagination links.Links

Hardware Sensor Model

FieldDescriptionData Type
idUnique identifier for the VergeSense hardware sensor. Ex: W00-123String
typesensorString
attributes.modelVergeSense hardware model. Ex: L302, E105String
attributes.firmwareFirmware version of the sensor (if available).String
attributes.mac_addressMAC address of the sensor.String
attributes.stateCurrent lifecycle state of the sensor. Can be one of the following:
pre_install
installed
partitioned
verified
operational
flagged
String
attributes.network.statusCurrent network status of the sensor. Can be one of the following:
online - the sensor has sent a report in the past hour
intermittent - the sensor has not sent a report in the past hour
offline - the sensor has not sent a report in the past 3 hours
asleep - the sensor is in a scheduled non-reporting state to save battery
String
attributes.network.last_message_timestampTimestamp in UTC of last received sensor message.String
attributes.battery.statusCurrent battery health of the sensor. Can be one of the following:
healthy - over 6 months estimated remaining life
replace_soon- less than 6 months estimated remaining life
replace_now - less than 2 months estimated remaining life
String
relationships.buildingThe building that the sensor is located within. Building details included in the included top level response key.Object
relationships.floorThe floor that the sensor is installed on. Floor details included in the included top level response key.Object
Language
Credentials
Header
Click Try It! to start a request and see the response here!