List the locations with Geofences

Purpose: Use this API to fetch a list of all the available Geofences.

šŸ“˜

NOTE

You must specify the category of the geofence. The category is nothing but the location where the Geofence has been configured. For more information refer to the Query Parameters section.

Response Parameters

Geofence

  • Type: Object
  • Description: Contains details of the geofence.

id

  • Type: Integer
  • Description: The unique identifier for the geofence.

name

  • Type: String
  • Description: The name of the geofence.

category

  • Type: String
  • Description: The category of the geofence, e.g., "Fuel Station".

status

  • Type: String
  • Description: The status of the geofence, e.g., "active".

address

  • Type: String
  • Description: The physical address associated with the geofence.

location_points

  • Type: Array of Objects
  • Description: A list of geographical points that define the boundaries of the geofence.

lat

  • Type: Float
  • Description: The latitude of a location point in the geofence.

lon

  • Type: Float
  • Description: The longitude of a location point in the geofence.

Query Params
string

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

string

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']

string

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

date

Specify the date after which the Geofence info was updated.

int32
Defaults to 25

The number of records to display per page.

int32
Defaults to 1

The current page number

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json