Locations

GET /locations/{id}

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.

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/locations/{id}
  • Auth
    HTTP bearer

Query parameters

includestring[]

List of properties that should be included in the response

Response

Successfully fetched

idstring

Unique identifier of the resource

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": "123e4567-e89b-12d3-a456-426614174000",
  "name": "CF2 - Austin Office",
  "parentId": "123e4567-e89b-12d3-a456-426614174000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.