Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Locations

List Locations

Returns a list of your locations.

get/v1/locations

Query parameters

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

order'created_at' | '-created_at' | 'updated_at' | '-updated_at'

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

Filter the locations using one of the available filters.

{
  "created_at": {
    "conditions": {
      "$after": "2024-01-01T00:00:00.000Z",
      "$before": "2024-01-01T00:00:00.000Z"
    }
  },
  "updated_at": {
    "conditions": {
      "$after": "2024-01-01T00:00:00.000Z",
      "$before": "2024-01-01T00:00:00.000Z"
    }
  }
}
end_datestring date-time
Example:2023-12-22T10:13:06.487Z

A filter on the list based on the end date. This will filter out all locations whose end date falls before the specified date and time. A date value must be presented in the ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16).

Response

Returns a dictionary that contains an array of locations. Each entry in the array is a separate location object. If no more locations are available, the resulting array will be empty. The result can be narrowed down according to specified (or default) filters.

objectstring

The type of the object represented by JSON. This object stores information about locations in a dictionary.

data_refstring

Identifies the name of the attribute that contains the array of metadata schema objects.

totalinteger

Total number of locations.

has_moreboolean

As query results are always limited (by the limit parameter), the has_more flag indicates if there are more records for given filter parameters. This lets you know if you can run another request (with a different end date filter) to get more records returned in the results.

Example response

{
  "data": [
    {
      "id": "loc_NoMGXmHO9OUs7iz9mGWpamma",
      "shape": {
        "distance": {
          "center": "geo:40.79372699823857,-74.15092132694554"
        }
      },
      "created_at": "2022-02-14T15:12:06.817Z",
      "updated_at": "2022-03-14T15:12:06.817Z"
    }
  ]
}