Sites
List sites
get/sites
Request
- Base URLhttps://api.voltairlabs.com
- Auth
- HTTP bearer
- or API key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
clusterIdstring uuid
unclusteredboolean
If true, return only sites with no cluster assignment. Cannot be combined with clusterId.
externalIdstring
Filter by customer-facing external identifier
tagsstring
Comma-separated tag values
prioritystring
Comma-separated priorities (high, medium, low, none)
siteTypestring
Comma-separated site types (e.g. substation,distribution_pole)
geometryType'Point' | 'LineString' | 'Polygon' | 'MultiLineString' | 'MultiPolygon'
Filter by the GeoJSON geometry type of the site
qstring
Case-insensitive substring match against name, externalId, and description
boundsstring
Bounding box: minLng,minLat,maxLng,maxLat
limitinteger
Page size (default 50, max 200)
cursorstring
Opaque pagination cursor from a previous response
Response
Success
Changes
No recorded changes to this operation across all 5 revisions of this API.