---
title: "Get Geofence List"
method: GET
path: "/geofence/list"
tags: ["Geofence"]
---

# Get Geofence List

`GET /geofence/list`

## Query parameters

- `tags` string, value_1,value_2,...
- `key` string, 32 character alphanumeric string, required
- `pn` integer
- `ps` integer

## Response `200`

OK

- DtoGetGeofenceListResp
  - `status` string — A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the [API Error Codes](#api-error-codes) section below for more information.
  - `data` object
    - `list` DtoGeofence[]
      - `id` string — ID of the geofence provided/generated at the time of creating the geofence.
      - `name` string — Name of the geofence added at the time of creating or updating it.
      - `type` 'circle' | 'polygon' | 'isochrone' — Type of the geofence.
      - `geojson` PolygonGeojson — An object with geoJSON details of the geofence. The contents of this object follow the [geoJSON standard](https://datatracker.ietf.org/doc/html/rfc7946).
        - `type` string — Type of the geoJSON geometry. Will always be Polygon.
        - `coordinates` array[] — An array of coordinates in the [longitude, latitude] format, representing the geofence boundary.
          - number[] — [longitude, latitude] format location.
      - `circle_center` DtoGeofencePosition
        - `lat` number — Latitude of the location.
        - `lon` number — Longitude of the location.
      - `circle_radius` number — When the type of the geofence is circle, this property returns the radius of the geofence in meters (m).
      - `ic_contours_meter` integer — For a geofence based on isochrone contour determined using a specific driving distance, this property returns the duration value, in meters. The value would be the same as that provided for the contours_meter parameter at the time of creating or updating the geofence.
      - `ic_contours_minute` integer — For a geofence based on isochrone contour determined using a specific driving duration, this property returns the duration value, in minutes. The value would be the same as the value provided for the contours_minute parameter at the time of creating or updating the geofence.
      - `ic_coordinates` string, latitude,longitude — For a geofence based on isochrone contour, this property returns the coordinates of the location, in [latitude,longitude] format, which was used as the starting point to identify the geofence boundary. The value would be the same as that provided for the coordinates parameter at the time of creating or updating the geofence.
      - `ic_departure_time` integer — For a geofence based on isochrone contour, this property returns the departure time, as a UNIX epoch timestamp in seconds, which was used to determine the geofence boundary after taking into account the traffic conditions at the time. The value would be the same as that provided for the departure_time parameter at the time of creating or updating the geofence.
      - `ic_mode` number — For a geofence based on isochrone contour, this property returns the driving mode used to determine the geofence boundary. The value would be the same as that provided for the mode parameter at the time of creating or updating the geofence.
      - `ic_denoise` number — For a geofence based on isochrone contour, this property returns the denoise value which would be the same as that provided for the denoise parameter at the time of creating or updating the geofence.
      - `tags` string[] — An array of strings representing the tags associated with the geofence added at the time of creating or updating it.
      - `created_at` integer — Time at which the geofence was created, expressed as a UNIX timestamp in seconds.
      - `updated_at` integer — Time at which the geofence was last updated, expressed as a UNIX timestamp in seconds.
      - `meta_data` object — Metadata of the geofence added at the time of creating or updating it.
    - `page` DtoPagination — An object with pagination details of the search results. Use this object to implement pagination in your application.
      - `total` integer — An integer value indicating the total number of items available in the data set. This parameter can be used to calculate the total number of pages available.
      - `page` integer — An integer value indicating the current page number (starting at 0).
      - `size` integer — An integer value indicating the maximum number of items retrieved per page.
      - `hasmore` boolean — A boolean value indicating whether there are more items available beyond the current page.

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

[API](https://skmtc.net/nextbillion-ai/apis/one-spec-service.md) · [All operations](https://skmtc.net/nextbillion-ai/apis/one-spec-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nextbillion-ai/one-spec-service/versions/b647f1808dda/schema)