Skip to main content
GET
Get Geofence Monitor

Authorizations

Authorization
string
header
required

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

Path Parameters

geofence_monitor_id
string<uuid>
required

Response

Successful Response

Geofence monitor read model

id
string<uuid>
required
webhook_group_id
string<uuid>
required

The geofence_monitor.* subscription this monitor's events are delivered to

fleet_id
string<uuid>
required

The Catena fleet whose vehicle is being watched

vehicle_id
string<uuid>
required

The Catena vehicle being watched

status
enum<string>
required

The monitor's lifecycle status. Non-terminal means still being watched.

Available options:
active,
completed,
expired,
cancelled
current_stop_sequence
integer
required

Which stop is currently being watched

starts_at
string<date-time>
required

Pings before this are ignored.

expires_at
string<date-time>
required

When the watch ends. A monitor still ACTIVE past this is marked EXPIRED.

created_at
string<date-time>
required

When the monitor was created

updated_at
string<date-time>
required

When the monitor last changed, including each stop transition

name
string | null
fleet_ref
string | null

Your own reference for the fleet

vin
string | null
license_plate_number
string | null
license_plate_region
string | null
license_plate_country
string | null
stops
GeofenceMonitorStopRead · object[]

The journey, in travel order

cancelled_at
string<date-time> | null

When the partner cancelled the monitor

completed_at
string<date-time> | null

When the vehicle departed the final stop, ending the watch