Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Locations

This endpoint allows retrieval of the location with a specific ID. Support for Location-based camera grouping is only available in the professional and enterprise editions.

get/locations/{id}

Query parameters

includestring[]

List of properties that should be included in the response

Response

Successfully fetched

idstring
namestring
parentIdstring

Unique identifier of this location's parent location in the hierarchy

isDefaultboolean

Specifies if a new device should be automatically assigned to this location if not supplied

Example response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "CF2 - Austin Office",
  "parentId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}