Skip to main content
GET
List Geofence Monitors

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

vehicle_id
string<uuid> | null
fleet_id
string<uuid> | null
status
enum<string> | null

Enum for geofence monitor status.

ACTIVE is the only non-terminal status: the tracker queries non-terminal monitors, so reaching any of the others is what ends the watch. There is no unsubscribe.

Departure and arrival are per-stop, not per-journey.COMPLETED means the last stop was reached.

Available options:
active,
completed,
expired,
cancelled
sort_by
enum<string>
default:created_at

Fields a list of geofence monitors can be sorted by

Available options:
created_at,
updated_at,
expires_at,
status
sort_order
enum<string>
default:desc

Enum for sort direction shared across paginated list endpoints

Available options:
asc,
desc
cursor
string | null

Cursor for the next page

size
integer
default:300

Page size

Required range: 1 <= x <= 1000

Response

Successful Response

items
GeofenceMonitorRead · object[]
required
total
integer
required
Required range: x >= 0
current_page
string | null

Cursor to refetch the current page

current_page_backwards
string | null

Cursor to refetch the current page starting from the last item

previous_page
string | null

Cursor for the previous page

next_page
string | null

Cursor for the next page