Get locations — devices

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB

Locations

This endpoint is used to retrieve a list of locations. Support for Location-based camera grouping is only available in the professional and enterprise editions. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available locations, not the number of locations resulting from the query string.

get/locations

Query parameters

includestring[]

List of properties that should be included in the response

sortstring[]

Sort by timestamp

pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

id__instring[]

Filter to get the accounts whose id is on the provided list. The lookup is exact and case insensitive.

parentIdstring

Example:d290f1ee-6c54-4b01-90e6-d701748f0851

Filter to get the locations with the specified parentId. parentId=null returns only the locations which do not have a parent location

parentId__nestring

Example:d290f1ee-6c54-4b01-90e6-d701748f0851

Filter to get the locations with the parentId that is not equal to the provided value. The lookup is exact and case insensitive

parentId__inId[]

Filter to get the locations whose parentId is on the provided list. The lookup is exact and case insensitive

[
  "d290f1ee-6c54-4b01-90e6-d701748f0851"
]

namestring

Name of the item.

Example:Video North Door 2022-08-03 23-04-50.mp4

Exact name of the item.

name__nestring

Filter to get the locations with the name that is not equal to the provided value. The lookup is exact and case insensitive

name__instring[]

Filter to get the locations whose name is on the provided list. The lookup is exact and case insensitive

name__containsstring

Filter to get the locations whose the name contains the provided substring. The lookup is exact and case insensitive

address.streetAddressstring

Filter to get the locations with the specified address.streetAddress. The lookup is exact and case insensitive

address.streetAddress__nestring

Filter to get the locations with an address.streetAddress that is not equal to the provided value. The lookup is exact and case insensitive

address.streetAddress__instring[]

Filter to get the locations whose address.streetAddress is on the provided list. The lookup is exact and case insensitive

address.streetAddress__containsstring

Filter to get the locations whose the address.streetAddress contains the provided substring. The lookup is exact and case insensitive

address.streetAddress2string

Filter to get the locations with the specified address.streetAddress2. The lookup is exact and case insensitive

address.streetAddress2__nestring

Filter to get the locations with an address.streetAddress2 that is not equal to the provided value. The lookup is exact and case insensitive

address.streetAddress2__instring[]

Filter to get the locations whose address.streetAddress2 is on the provided list. The lookup is exact and case insensitive

address.streetAddress2__containsstring

Filter to get the locations whose the address.streetAddress2 contains the provided substring. The lookup is exact and case insensitive

address.citystring

Filter to get the locations with the specified address.city. The lookup is exact and case insensitive

address.city__nestring

Filter to get the locations with an address.city that is not equal to the provided value. The lookup is exact and case insensitive

address.city__instring[]

Filter to get the locations whose address.city is on the provided list. The lookup is exact and case insensitive

address.city__containsstring

Filter to get the locations whose the address.city contains the provided substring. The lookup is exact and case insensitive

address.regionstring

Filter to get the locations with the specified address.region. The lookup is exact and case insensitive

address.region__nestring

Filter to get the locations with an address.region that is not equal to the provided value. The lookup is exact and case insensitive

address.region__instring[]

Filter to get the locations whose address.region is on the provided list. The lookup is exact and case insensitive

address.region__containsstring

Filter to get the locations whose the address.region contains the provided substring. The lookup is exact and case insensitive

address.countrystring

Filter to get the locations with the specified address.country. The lookup is exact and case insensitive

address.country__nestring

Filter to get the locations with an address.country that is not equal to the provided value. The lookup is exact and case insensitive

address.country__instring[]

Filter to get the locations whose address.country is on the provided list. The lookup is exact and case insensitive

address.country__containsstring

Filter to get the locations whose the address.country contains the provided substring. The lookup is exact and case insensitive

address.postalCodestring

Filter to get the locations with the specified address.postalCode. The lookup is exact and case insensitive

address.postalCode__nestring

Filter to get the locations with an address.postalCode that is not equal to the provided value. The lookup is exact and case insensitive

address.postalCode__instring[]

Filter to get the locations whose address.postalCode is on the provided list. The lookup is exact and case insensitive

address.postalCode__containsstring

Filter to get the locations whose the address.postalCode contains the provided substring. The lookup is exact and case insensitive

childLocationCountinteger

Filter to get the locations with the specified number of direct children

childLocationCount__neinteger

Filter to get the locations with the number of direct children not equal to the provided value.

qstring

Example:entrance

Text search that is applied to multiple fields. The fields being searched are defined by the backend and can be changed without warning. Example fields being searched: name, id, notes.

qRelevance__gtenumber float

Example:0.5

Sets the current minimum similarity threshold that is used with the q parameter. The threshold must be between 0 and 1 (float, default is 0.5).

Response

Successfully fetched

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger required

Size of the total result set.

Example response

{
  "results": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "name": "CF2 - Austin Office",
      "parentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "address": {
        "country": "USA",
        "region": "Texas",
        "city": "Austin",
        "streetAddress": "4611 Bee Caves Rd",
        "streetAddress2": "SUITE 102",
        "postalCode": "78746"
      },
      "geometry": {
        "type": "MultiPolygon",
        "coordinates": [
          [
            [
              [
                40,
                40
              ],
              [
                20,
                45
              ],
              [
                45,
                30
              ],
              [
                40,
                40
              ]
            ]
          ],
          [
            [
              [
                20,
                35
              ],
              [
                10,
                30
              ],
              [
                10,
                10
              ],
              [
                30,
                5
              ],
              [
                45,
                20
              ],
              [
                20,
                35
              ]
            ],
            [
              [
                30,
                20
              ],
              [
                20,
                15
              ],
              [
                20,
                25
              ],
              [
                30,
                20
              ]
            ]
          ]
        ],
        "bbox": [
          -10,
          -10,
          10,
          10
        ]
      },
      "resourceCounts": {
        "cameras": 23,
        "bridges": 2,
        "speakers": 1,
        "users": 12,
        "multiCameras": 3
      },
      "qRelevance": 0.5
    }
  ]
}