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 
Response samples 
application/json
{
  • "metadata": {
    },
  • "data": [
    ]
}
© 2023 Lytx, Inc. All rights reserved