Skip to main content
GET
Get site

Authorizations

x-api-key
string
header
required

Path Parameters

uuid
string<uuid>
required

UUID of the site to retrieve

Response

Successful response

A site represents a physical location for devices

uuid
string<uuid>
required

Unique identifier

orgUuid
string<uuid>
required

Organisation the site belongs to

name
string
required

Site name

description
string | null
required

Optional description

timezone
string | null
required

IANA timezone override for devices at this site (e.g., 'Australia/Sydney')

devices
DeviceItem · object[] | null

Devices assigned to this site, if requested

gnss
SiteGnssConfig · object | null

GNSS configuration, base stations, and projections for this site. Null when not configured.

sharedBy
SharedBy · object

Present when this site is shared from another organisation