API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Get sites

This API is used to fetch information about all sites, based on the query parameters provided. Each site in the returned list includes details like the scopeId, scopeName, collectionId, collectionName, deviceCount, image, the address params and geolocation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
required
1 to 100
Defaults to 100

Number of sites that need to be fetched. (Default: 100) Maximum limit per query is 100.

int32
required
0 to 2147483647
Defaults to 0

Offset from where the sites need to be fetched.

string
length ≤ 256

OData 4.0 filter supports filtering on fields scopeName, address, city, state, country, zipcode, collectionName.

string
length ≤ 256

Sort by field. May be one of scopeName, address, state, country, city, deviceCount, collectionName, zipcode, timezone, longitude, latitude.

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