---
title: "List Locations"
method: GET
path: "/v1/locations"
tags: ["Locations"]
---

# List Locations

`GET /v1/locations`

Returns a list of your locations.

## Query parameters

- `limit` integer
- `order` 'created_at' | '-created_at' | 'updated_at' | '-updated_at'
- `filters` ParameterFiltersListLocations
  - `name` object
    - `conditions` FilterConditionsString — Data filters used to narrow down the data records to be returned in the result.
      - `$in` string[] — Array of resource values that should be included in the results (multiple values).
      - `$not_in` string[] — Array of resource values that should be included in the results (multiple values).
      - `$is` string — Value is exactly this value (single value).
      - `$is_not` string — Results omit this value (single value).
      - `$has_value` string — Value is NOT null. The value for this parameter is an empty string.
      - `$is_unknown` string — Value is null. The value for this parameter is an empty string.
      - `$starts_with` string — Value starts with the specified string.
      - `$ends_with` string — Value ends with the specified string.
      - `$contains` string — Value includes the specified string.
      - `$not_contain` string — Value does NOT include the specified string.
  - `created_at` object — Timestamp representing the date and time when the location was created. The value is shown in the ISO 8601 format.
    - `conditions` FilterConditionsDateTime — Data filters used to narrow down the data records to be returned in the result.
      - `$after` string, date-time — Value is after this date. The value for this parameter is shown in the ISO 8601 format.
      - `$before` string, date-time — Value is before this date. The value for this parameter is shown in the ISO 8601 format.
      - `$has_value` string — Value is NOT null. The value for this parameter is an empty string.
      - `$is_unknown` string — Value is null. The value for this parameter is an empty string.
      - `$more_than` integer — Value is more days ago before the current date and time, e.g. more than `10` days ago.
      - `$less_than` integer — Value is less days before the current date and time, e.g. less than `10` days ago.
  - `updated_at` object — Timestamp representing the date and time when the location was updated. The value is shown in the ISO 8601 format.
    - `conditions` FilterConditionsDateTime — Data filters used to narrow down the data records to be returned in the result.
      - `$after` string, date-time — Value is after this date. The value for this parameter is shown in the ISO 8601 format.
      - `$before` string, date-time — Value is before this date. The value for this parameter is shown in the ISO 8601 format.
      - `$has_value` string — Value is NOT null. The value for this parameter is an empty string.
      - `$is_unknown` string — Value is null. The value for this parameter is an empty string.
      - `$more_than` integer — Value is more days ago before the current date and time, e.g. more than `10` days ago.
      - `$less_than` integer — Value is less days before the current date and time, e.g. less than `10` days ago.
- `end_date` string, date-time

## Response `200`

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.

- LocationsListResponseBody — Response schema for listing locations using **GET** `v1/locations`.
  - `object` string — The type of the object represented by JSON. This object stores information about locations in a dictionary.
  - `data_ref` string — Identifies the name of the attribute that contains the array of metadata schema objects.
  - `data` Location[] — Array of location objects.
    - `id` string, required — Unique location ID, assigned by the Voucherify API.
    - `object` 'location', required — The type of the object represented by JSON. This object stores information about a `location`.
    - `name` string, required — Location name.
    - `shape` union, required — Defines the shape and boundaries of the location.
      - object — This is an object representing a circular shape.
        - `type` 'circle', required — The type of shape being defined is a `circle`.
        - `format` 'distance', required — The location is defined in terms of a `distance` object.
        - `distance` object, required — Defines the parameters for the circle.
          - `center` string — Center of the circle identified by GPS coordinates in decimal degrees.
          - `radius` string — Defines the radius of the circle.
      - object — This is an object representing a polygon.
        - `type` 'polygon', required — The type of shape being defined is a `polygon`.
        - `format` 'geojson', required — The location is defined in terms of a `geojson` object.
        - `geojson` union, required
          - GeojsonPolygon — Defines the parameters for the polygon.
            - `type` 'Polygon', required — Type of geojson coordinates, i.e. `Polygon`.
            - `coordinates` array[], required
              - …
          - GeojsonMultiPolygon — Defines the parameters for the polygon.
            - `type` 'MultiPolygon', required — Type of geojson coordinates, i.e. `MultiPolygon`.
            - `coordinates` PolygonCoordinates[], required
              - …
    - `created_at` string, date-time, required — Timestamp representing the date and time when the location was created. The value is shown in the ISO 8601 format.
    - `updated_at` string, date-time, nullable, required — Timestamp representing the date and time when the location was updated. The value is shown in the ISO 8601 format.
  - `total` integer — Total number of locations.
  - `has_more` boolean — 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.

---

[API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/revisions/4982266e0494/schema)