Skip to main content
GET
/
sites
List sites
curl --request GET \
  --url https://api.beta.ontoto.com/v1/sites \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "uuid": "31d09506-82da-4f9d-960f-a871bae63258",
      "orgUuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "name": "River Dam",
      "description": "Main monitoring location",
      "timezone": "Australia/Hobart",
      "gnss": null
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
uuids
string[]

Filter by specific site UUIDs

​
includeDevices
string

When true, each site includes assigned devices in a devices array.

​
includeSensors
string

When true, include sensors on each device. Only applies when includeDevices=true.

Response

Successful response

Response body for querying sites.

​
items
SiteItem · object[]
required