NEnextbillion-ai
Geofence

Get Geofence List

Changed on
get/geofence/list

Request

Query parameters

tagsstring value_1,value_2,...
Example:tags=tags_1,O69Am2Y4KL8q5Y5JuD-Fy-tdtEpkTRQo_ZYIK7

Comma (,) separated list of tags which will be used to filter the geofences.

Please note only the geofences which have all the tags added to this parameter will be included in the result. This parameter can accept a string with a maximum length of 256 characters.

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

pninteger

Denotes page number. Use this along with the ps parameter to implement pagination for your searched results. This parameter does not have a maximum limit but would return an empty response in case a higher value is provided when the result-set itself is smaller.

psinteger

Denotes number of search results per page. Use this along with the pn parameter to implement pagination for your searched results.

Response

OK

statusstring

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 section below for more information.

Example response

{
  "data": {
    "list": [
      {
        "ic_coordinates": "\"ic_coordinates\":13.258058,77.910836"
      }
    ]
  }
}

Changes

  • 7ee76f0ff679Revision changes
    • warning

      added the new circle enum value to the /// response property for the response status

    • warning

      added the new isochrone enum value to the /// response property for the response status

    • warning

      added the new polygon enum value to the /// response property for the response status

    • info

      removed the circle enum value from the /// response property for the response status

    • info

      removed the isochrone enum value from the /// response property for the response status

    • info

      removed the polygon enum value from the /// response property for the response status

  • a800b73f11c1Revision changes
    • warning

      added the new circle enum value to the /// response property for the response status

    • warning

      added the new isochrone enum value to the /// response property for the response status

    • warning

      added the new polygon enum value to the /// response property for the response status

    • info

      removed the circle enum value from the /// response property for the response status

    • info

      removed the isochrone enum value from the /// response property for the response status

    • info

      removed the polygon enum value from the /// response property for the response status