API Reference
API ReferenceChangelogLog In
API Reference

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

Response

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

Hardware Gateway Model

FieldDescriptionData Type
idUnique identifier for the VergeSense hardware gateway. Ex: C0300A1234-01234String
typegatewayString
attributes.modelVergeSense hardware model. Ex: rigadoString
attributes.firmwareFirmware version of the gateway (if available).String
attributes.mac_addressMAC address of the gateway.String
attributes.network.statusCurrent network status of the gateway. Can be one of the following:
offline - the gateway has not sent a report in over an hour
online - the gateway has sent a report in the last hour
String
relationships.buildingThe building that the gateway is located within. Building details included in the included top level response key.Object
relationships.floorThe floor that the gateway 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!