Locations API

A Location defined a physical location for a LiveReach deployment. Typically all NVRs, Cameras, and other devices within a location are colocated and may even be on the same physical network. It is not required for a paired camera and NVR to be in the same physical location. A location can also be used a permission boundary where users may only have access to resources within an assigned location.

The Location object

Attributes

idintegerRead-onlyOptional

organization_idintegerOptional

namestringOptionalExample: One Apple Park Way, Cupertino, CA 95014

coordnumber · double[] · min: 2 · max: 2Optional

[longitude, latitude]

Example: [-87.9073214,41.97416]

createdstring · date-timeRead-onlyOptional

updatedstring · date-timeRead-onlyOptional

timezonestringRead-onlyOptionalExample: America/Los_Angeles

regionstring · enumRead-onlyOptionalPossible values:

countrystring · min: 2 · max: 2Read-onlyOptionalExample: US

statestringRead-onlyOptionalExample: CA

citystringRead-onlyOptionalExample: Cupertino

metadataobjectOptionalExample: {"foo":"bar"}

The Location object

{
  "id": 1,
  "organization_id": 1,
  "name": "One Apple Park Way, Cupertino, CA 95014",
  "coord": [
    -87.9073214,
    41.97416
  ],
  "created": "2026-03-11T09:48:07.308Z",
  "updated": "2026-03-11T09:48:07.308Z",
  "timezone": "America/Los_Angeles",
  "region": "US",
  "country": "US",
  "state": "CA",
  "city": "Cupertino",
  "metadata": {
    "foo": "bar"
  }
}