v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

List the locations with Geofences

get/v1/geofences

Query parameters

namestring

Specify the name of the geofence that was saved. NOTE: If you are searching for partial information then use this fileter.

categorystring

Specify the category of the Geofence. Allowed values are: ['Uncategorized', 'Fuel Station', 'Job Site', 'Maintenance Facility', 'Receiver / Consignee', 'Restricted Location', 'Shipper', 'Terminal / Yard', 'Truck Stop / Rest Area', 'Weigh Station / Scale', 'Shipper / Receiver']

statusstring

Specify the status of the Geofence. Allowed values are active and deactivated.

updated_afterstring date

Specify the date after which the Geofence info was updated.

per_pageinteger

The number of records to display per page.

page_nointeger

The current page number

Response

200

Example response

{
  "geofences": [
    {
      "geofence": {
        "id": 1004,
        "name": "alpha",
        "category": "Fuel Station",
        "status": "active",
        "address": "1303 N Collins St, Arlington, TX 76011, USA",
        "location_points": [
          {
            "lat": 33.667893,
            "lon": 73.062074
          }
        ]
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 3
  }
}