Retrieve Geofences

Retrieve a list of Geofences filtered by identifier. Only 0 or 1 identifiers are allowed in a query.

SecuritybearerAuth

Request

query Parameters

geofenceIdentifier	string or null Unique Id for Geofence Example: geofenceIdentifier=2CB2D9B4-C801-E111-81CE-E61F13277AAB
deviceIdentifier	string or null Filter by Device Id or Serial Number. Example: deviceIdentifier=5100FFFF-60B6-D7CD-3FA2-22CA712B0000
groupIdentifier	string or null Filter by Group Identifier. Example: groupIdentifier=5100FFFF-60B6-D7CD-3FA2-22CA712B0000
vehicleIdentifier	string or null Filter by Vehicle Identifier or Vin. Example: vehicleIdentifier=5100FFFF-60B6-D7CD-3FA2-22CA712B0000
startDate	string <date-time> Filter by start date. Example: startDate=2023-06-01
endDate	string <date-time> Filter by end date. Example: endDate=2023-06-02
offset	integer or null Record to start with. Example: offset=1500
limit	integer or null Number of records to return. Example: limit=5000
order	string or null Sort direction. Example: order=asc
sort	string or null Name of field to sort on. Sort field must be either "name", "groupId", "groupName", "isInside", or "creationDate". Example: sort=GeofenceName
includeSubGroups	boolean Include Sub Groups. Example: includeSubGroups=false

Responses

200

204

No Content: HTTP request has been successfully completed, and there is no message body

400

Bad Request

401

Unauthorized.

403

Forbidden

404

Not Found

500

Internal Server Error.

get/v1/geofences

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"metadata": {"limit": 5000,
"count": 5000,
"offset": 0,
"startDate": "2024-07-10T12:12:12Z",
"endDate": "2024-07-11T12:12:12Z"
},
"data": [{"geofenceId": "3F136C14-79C8-4BAA-B9DE-ADA9C0C68EBC",
"name": "San Diego 92120",
"rootGroupId": "2BB2D9B4-C801-E111-81CE-E61F13277AAB",
"groupId": "2BB2D9B4-C801-E111-81CE-E61F13277AAB",
"groupName": "Root Group",
"groupPath": "2BB2D9B4-C801-E111-81CE-E61F13277AAB\\\\2CB2D9B4-C801-E111-81CE-E61F13277AAB",
"includeSubGroups": true,
"isInside": true,
"geofenceGeography": {"radius": 25,
"shapeType": 3,
"points": [{"latitude": 0,
"longitude": 0
}
]
},
"color": "#800080",
"effectiveDaysOfWeek": "1,3,5",
"createdDate": "2024-06-28T15:31:42.8955131Z",
"assetGroupId": "2CB2D9B4-C801-E111-81CE-E61F13277AAB",
"assetIncludeSubGroups": false,
"assets": [{"assetId": "5100FFFF-60B6-D7CD-3FA2-22CA712B0000",
"assetType": "vehicle"
}
],
"effectiveStartTime": "15:00:00",
"effectiveEndTime": "05:59:00",
"effectiveTimezoneOffset": "-7:00"
}
]
}