HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference

List devices with location information

This API endpoint retrieves a list of network devices that have been assigned location information (e.g. After being placed on a floorplan and/or automatically determined by the system). Each device in the returned list includes details like serial number, MAC address, IP address, consolidated location, etc. The consolidated location of a device is the best known location of the device (x/y coordinates on the floorplan and/or latitude/longitude geo-coordinates) with the administrator specified position always taking precedence. The query parameters allow you to narrow down the results to devices that meet specific criteria, ensuring you receive only the relevant data. Device lists are restricted to a single site represented by the required site-id query parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 128

ID of the Site for which device location information is requested

Query Params
string
length ≤ 256

OData 4.0 filter (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supports filtering on fields floorId and buildingId only.

int32
0 to 1000
Defaults to 100

Denotes the maximum number of devices returned in the response. (Default: 100)

string

Specifies the pagination cursor for the next page of resources.

int64
0 to 9223372036854776000

Retrieve data at the specified timestamp. Given in milliseconds from epoch. If no timestamp is provided, the current time will be used by default.

boolean
Defaults to true

Filter for devices with or without location based on this parameter.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json