These docs are for v1. Click to read the latest docs for v3.

View

This API provides you with information about all active geofences present in your account.

📘

Sample Request

https://api.azuga.com/azuga-ws/v1/geofence/view.json?groupName=WestCoast&USA-1&USA-4

API Response explanation

Field

Description

code

API Status Code

message

API Message

generatedAt

API generation timestamp in UTC

reason

The reason for failure

currentPage

The current page

totalPages

The total number of pages in the result

fenceId

Unique identifier representing the geofence

name

Name of the geofence

createdAt

Geofence creation timestamp in UTC

fenceType

Type of geofence, circular or polygonal

radius

Radius of the geofence, if it is circular

radiusUnit

Unit of radius of the geofence, if it is circular

geometry

If the fence type is polygonal, this field returns the latitude and longitude coordinates of the end points of the polygon.

For a circular geofence, this field is null

address

Address of the geofence

latitude

Latitude coordinate of the geofence

longitude

Longitude coordinate of the geofence

alertType

Type of alert based on the event (vehicle entry and/or exit)

email

List of email addresses to which the alert email will be sent

color

Color of the geofence

ccAddress

Email address(es) to which the alert mail is sent apart from the primary email address

groupNames

Names of the groups associated with the geofence

mode

Frequency of the alert email.
0 - Indicates that the email is sent instantly
60 - Indicates that the email is sent once an hour

reserved1

Reserved variable for future use

reserved2

Reserved variable for future use

reserved3

Reserved variable for future use

reserved4

Reserved variable for future use

Language
Credentials
Header
Click Try It! to start a request and see the response here!