Trax Public API

Entity Reference

Full field-level structure of every public resource — default fields, optional fields (?fields=), expandable relationships (?include=), filters, and one example response per entity. 117 operations across 23 entities plus device status, the summary aggregations, and the media, geocoding, and text-to-speech actions. For request/response schemas, parameters, and "Try it out", see the API Reference.

DevicesGETPOSTPATCH

Vehicles and trackers (identity, status, group membership); live position via the status sub-resource.

devices:read devices:write Read devices and their live status

Add-on callers: Narrowed to the user's viewing groups via GroupsIds. Records with no group ids stay visible to everyone.

GETRead

List (GET /v1/devices), query (POST /v1/devices/query) and fetch one (GET /v1/devices/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
namestring
serialstringDevice hardware serial (ESN/IMEI). Optional, but must be unique within the company when supplied. Create-only (frozen after creation).
typestringTracker type. Optional and create-only; currently only CustomTracker is accepted (any other value is rejected), and it defaults to CustomTracker when omitted.
statusstring
company_idstring
has_cameraboolean, nullable
last_connected_atstring (date-time)
last_known_locationobject, nullableLast-known GPS position from the device's latest packet. null when the device has never reported a fix.
speed_kmhnumber
headingnumber
is_ignition_onboolean
odometer_kmnumber
device_categorystring, nullableNormalized device category from the matching tracker type (trackertypes.DeviceCategory), e.g. "Asset Tracker". null when the device Type has no matching tracker type.
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
group_idsarray of string
vinstring
license_platestring
manufacturerstring
modelstring
yearnumber
engine_hoursnumber
activation_datestring (date-time)
tracker_modelstring
assigned_driver_idstring
parent_idstring
asset_tagstring
is_activeboolean
one_idstring
region_idsarray of string
business_group_idsarray of string
altitudenumber
state_duration_msnumber
last_packet_atstring (date-time)
last_online_packet_atstring (date-time)
last_gps_packet_atstring (date-time)
created_atstring (date-time)
removed_atstring (date-time)
shipped_atstring (date-time)
vendor_warranty_expires_atstring (date-time)
phonestring
geotab_serialstring
globalstar_esnstring
smartwitness_dridstring
billing_skustring
billing_sku_idstring
surfsight_serialstring
bewhere_beacon_idstring
imeistring
commentstring
additional_driver_idsarray of string
driver_assignment_modestring
custom_pricenumber
share_master_device_idstring
suspend_exception_videoboolean
is_suspendedboolean
camera_onlineboolean
camera_standbyboolean
last_camera_contact_atstring (date-time)
oldest_recording_atstring (date-time)
latest_recording_atstring (date-time)
parent_geotab_idstring
indoor_dataobject, nullableIndoor-tracking connection data (BLE beacons only), forwarded as-is. null when not applicable.
signal_dbmnumber
beacon_typestring
is_health_recordingboolean
has_video_lossboolean
camera_channelsarray of number
iccidstring
telematic_serialstring
colorstring
skill_tagsarray of string
asset_typestring
image_urlstring
asset_statusstring
data_usage_statusstring
termination_datestring (date-time)
device_planstring
billing_tagstring
so_numberstring
agreement_length_monthsnumber
subscription_pricenumber
data_plan_mbnumber
sim_typestring
is_streamax_v3boolean
has_pending_mediaboolean
acc_statusobject, nullableStreamax ACC (ignition switch) detection state, forwarded as-is. null when not available.
financeobject, nullableBilling/finance details, forwarded as-is.
config_template_idstring
config_template_statusstring
config_odometer_statusstring
last_config_template_applied_atstring (date-time)
last_odometer_update_atstring (date-time)
pending_commandsarray of string
protocolstring
addressstring
address_colorstring
face_channelnumber
installer_emailstring
custom_fieldsobjectTenant-defined custom field values, keyed by field name, forwarded as-is.
device_plan_configurationobject, nullableDevice plan configuration, forwarded as-is.
streamax_device_idstring
is_tracing_enabledboolean
is_obd_availableboolean
whitelist_enabledboolean
is_outdoor_bleboolean
tx_powernumber
is_obd_engine_hours_availableboolean
is_obd_odometer_availableboolean
hos_enabledboolean
license_statestring
license_countrystring
registration_expires_atstring (date-time)
switchboard_idstring
Relationships (?include=)

Expand with ?include=x,y.

NameExpands toNotes
groupsArray of GroupsArray of Groups (empty if none)
assigned_driverDriversDrivers object (null if none)
Filters

Filter via POST /v1/devices/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
nameeq in contains starts_withString (case-insensitive). Discover valid values via GET /v1/devices.
serialeq in contains starts_withString (case-insensitive).
typeeq in contains starts_withString (case-insensitive). Discover valid values via GET /v1/devices.
statuseq in contains starts_withString (case-insensitive). Values: Active, Suspended, Terminated.
company_ideq in contains starts_withString (exact match).
has_cameraeqBoolean (exact match).
last_connected_ateq in gte lte betweenDate (exact match).
speed_kmheq in gte lte betweenNumber (exact match).
headingeq in gte lte betweenNumber (exact match).
is_ignition_oneqBoolean (exact match).
odometer_kmeq in gte lte betweenNumber (exact match).
group_idseq inArray of string (exact match).
vineq in contains starts_withString (case-insensitive).
license_plateeq in contains starts_withString (case-insensitive).
manufacturereq in contains starts_withString (case-insensitive).
modeleq in contains starts_withString (case-insensitive).
yeareq in gte lte betweenNumber (exact match).
engine_hourseq in gte lte betweenNumber (exact match).
activation_dateeq in gte lte betweenDate (exact match).
tracker_modeleq in contains starts_withString (case-insensitive).
assigned_driver_ideq in contains starts_withString (exact match).
parent_ideq in contains starts_withString (exact match).
asset_tageq in contains starts_withString (case-insensitive).
is_activeeqBoolean (exact match).

Example

POST /v1/devices/query
{
  "filters": {
    "status": "Active",
    "id": {
      "in": [
        "dvc_5f8a1c2b9e",
        "dvc_9c3f21a08b"
      ]
    },
    "last_connected_at": {
      "gte": "2026-07-15T08:30:00.000Z"
    },
    "name": {
      "contains": "Truck"
    }
  },
  "sort": "last_connected_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (type, status, name, serial, group_id, tag) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "dvc_5f8a1c2b9e",
      "name": "Truck 42",
      "serial": "SN-88213047",
      "type": "string",
      "status": "Active",
      "company_id": "acme",
      "has_camera": true,
      "last_connected_at": "2026-07-15T08:30:00.000Z",
      "last_known_location": {
        "latitude": 43.6532,
        "longitude": -79.3832,
        "located_at": "2026-07-15T08:30:00.000Z"
      },
      "speed_kmh": 64.2,
      "heading": 180,
      "is_ignition_on": true,
      "odometer_km": 104532.7,
      "device_category": "string",
      "group_ids": [
        "grp_1a2b3c4d5e"
      ],
      "vin": "1FTFW1E5XKF12345",
      "license_plate": "ABC-1234",
      "manufacturer": "Ford",
      "model": "F-150",
      "year": 2022,
      "engine_hours": 42.5,
      "activation_date": "2026-07-15T08:30:00.000Z",
      "tracker_model": "GO9",
      "assigned_driver_id": "drv_7a1e4c8f02",
      "parent_id": "par_9c3f21a08b",
      "asset_tag": "string",
      "is_active": true,
      "one_id": "one_9c3f21a08b",
      "region_ids": [
        "string"
      ],
      "business_group_ids": [
        "string"
      ],
      "altitude": 42.5,
      "state_duration_ms": 42.5,
      "last_packet_at": "2026-07-15T08:30:00.000Z",
      "last_online_packet_at": "2026-07-15T08:30:00.000Z",
      "last_gps_packet_at": "2026-07-15T08:30:00.000Z",
      "created_at": "2026-07-15T08:30:00.000Z",
      "removed_at": "2026-07-15T08:30:00.000Z",
      "shipped_at": "2026-07-15T08:30:00.000Z",
      "vendor_warranty_expires_at": "2026-07-15T08:30:00.000Z",
      "phone": "+1-555-0142",
      "geotab_serial": "string",
      "globalstar_esn": "string",
      "smartwitness_drid": "string",
      "billing_sku": "string",
      "billing_sku_id": "bil_9c3f21a08b",
      "surfsight_serial": "string",
      "bewhere_beacon_id": "bew_9c3f21a08b",
      "imei": "string",
      "comment": "string",
      "additional_driver_ids": [
        "string"
      ],
      "driver_assignment_mode": "string",
      "custom_price": 42.5,
      "share_master_device_id": "sha_9c3f21a08b",
      "suspend_exception_video": true,
      "is_suspended": true,
      "camera_online": true,
      "camera_standby": true,
      "last_camera_contact_at": "2026-07-15T08:30:00.000Z",
      "oldest_recording_at": "2026-07-15T08:30:00.000Z",
      "latest_recording_at": "2026-07-15T08:30:00.000Z",
      "parent_geotab_id": "par_9c3f21a08b",
      "indoor_data": {},
      "signal_dbm": 42.5,
      "beacon_type": "string",
      "is_health_recording": true,
      "has_video_loss": true,
      "camera_channels": [
        42.5
      ],
      "iccid": "string",
      "telematic_serial": "string",
      "color": "#2188D9",
      "skill_tags": [
        "hazmat"
      ],
      "asset_type": "string",
      "image_url": "string",
      "asset_status": "string",
      "data_usage_status": "string",
      "termination_date": "2026-07-15T08:30:00.000Z",
      "device_plan": "string",
      "billing_tag": "string",
      "so_number": "string",
      "agreement_length_months": 42.5,
      "subscription_price": 42.5,
      "data_plan_mb": 42.5,
      "sim_type": "string",
      "is_streamax_v3": true,
      "has_pending_media": true,
      "acc_status": {},
      "finance": {},
      "config_template_id": "con_9c3f21a08b",
      "config_template_status": "string",
      "config_odometer_status": "string",
      "last_config_template_applied_at": "2026-07-15T08:30:00.000Z",
      "last_odometer_update_at": "2026-07-15T08:30:00.000Z",
      "pending_commands": [
        "string"
      ],
      "protocol": "string",
      "address": "123 Main St",
      "address_color": "string",
      "face_channel": 42.5,
      "installer_email": "string",
      "custom_fields": {},
      "device_plan_configuration": {},
      "streamax_device_id": "str_9c3f21a08b",
      "is_tracing_enabled": true,
      "is_obd_available": true,
      "whitelist_enabled": true,
      "is_outdoor_ble": true,
      "tx_power": 42.5,
      "is_obd_engine_hours_available": true,
      "is_obd_odometer_available": true,
      "hos_enabled": true,
      "license_state": "ON",
      "license_country": "CA",
      "registration_expires_at": "2026-07-15T08:30:00.000Z",
      "switchboard_id": "swi_9c3f21a08b",
      "groups": [
        {
          "id": "grp_5f8a1c2b9e",
          "name": "Truck 42"
        }
      ],
      "assigned_driver": {
        "id": "drv_5f8a1c2b9e",
        "first_name": "Jane",
        "last_name": "Doe",
        "username": "jdoe"
      }
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}
POST PATCHWrite

devices:write Requires the write scope. All request/response bodies use the standard { data, meta } envelope.

Create — POST /v1/devices

Required: name. Full request body — every writable field (send only what you need; the required fields must be present):

{
  "name": "string",
  "serial": "string",
  "type": "string",
  "group_ids": [
    "string"
  ],
  "vin": "string",
  "license_plate": "string",
  "manufacturer": "string",
  "model": "string",
  "year": 0,
  "parent_id": "string",
  "asset_tag": "string",
  "phone": "string",
  "beacon_type": "string",
  "color": "string",
  "skill_tags": [
    "string"
  ],
  "asset_type": "string",
  "image_url": "string",
  "asset_status": "string",
  "hos_enabled": true,
  "license_state": "string",
  "license_country": "string",
  "registration_expires_at": "2026-01-01T00:00:00Z"
}
Response
{
  "data": {
    "id": "dvc_5f8a1c2b9e",
    "name": "Truck 42",
    "serial": "SN-88213047",
    "type": "string",
    "status": "Active",
    "company_id": "acme",
    "has_camera": true,
    "last_connected_at": "2026-07-15T08:30:00.000Z",
    "last_known_location": {
      "latitude": 43.6532,
      "longitude": -79.3832,
      "located_at": "2026-07-15T08:30:00.000Z"
    },
    "speed_kmh": 64.2,
    "heading": 180,
    "is_ignition_on": true,
    "odometer_km": 104532.7,
    "device_category": "string",
    "group_ids": [
      "grp_1a2b3c4d5e"
    ],
    "vin": "1FTFW1E5XKF12345",
    "license_plate": "ABC-1234",
    "manufacturer": "Ford",
    "model": "F-150",
    "year": 2022,
    "engine_hours": 42.5,
    "activation_date": "2026-07-15T08:30:00.000Z",
    "tracker_model": "GO9",
    "assigned_driver_id": "drv_7a1e4c8f02",
    "parent_id": "par_9c3f21a08b",
    "asset_tag": "string",
    "is_active": true,
    "one_id": "one_9c3f21a08b",
    "region_ids": [
      "string"
    ],
    "business_group_ids": [
      "string"
    ],
    "altitude": 42.5,
    "state_duration_ms": 42.5,
    "last_packet_at": "2026-07-15T08:30:00.000Z",
    "last_online_packet_at": "2026-07-15T08:30:00.000Z",
    "last_gps_packet_at": "2026-07-15T08:30:00.000Z",
    "created_at": "2026-07-15T08:30:00.000Z",
    "removed_at": "2026-07-15T08:30:00.000Z",
    "shipped_at": "2026-07-15T08:30:00.000Z",
    "vendor_warranty_expires_at": "2026-07-15T08:30:00.000Z",
    "phone": "+1-555-0142",
    "geotab_serial": "string",
    "globalstar_esn": "string",
    "smartwitness_drid": "string",
    "billing_sku": "string",
    "billing_sku_id": "bil_9c3f21a08b",
    "surfsight_serial": "string",
    "bewhere_beacon_id": "bew_9c3f21a08b",
    "imei": "string",
    "comment": "string",
    "additional_driver_ids": [
      "string"
    ],
    "driver_assignment_mode": "string",
    "custom_price": 42.5,
    "share_master_device_id": "sha_9c3f21a08b",
    "suspend_exception_video": true,
    "is_suspended": true,
    "camera_online": true,
    "camera_standby": true,
    "last_camera_contact_at": "2026-07-15T08:30:00.000Z",
    "oldest_recording_at": "2026-07-15T08:30:00.000Z",
    "latest_recording_at": "2026-07-15T08:30:00.000Z",
    "parent_geotab_id": "par_9c3f21a08b",
    "indoor_data": {},
    "signal_dbm": 42.5,
    "beacon_type": "string",
    "is_health_recording": true,
    "has_video_loss": true,
    "camera_channels": [
      42.5
    ],
    "iccid": "string",
    "telematic_serial": "string",
    "color": "#2188D9",
    "skill_tags": [
      "hazmat"
    ],
    "asset_type": "string",
    "image_url": "string",
    "asset_status": "string",
    "data_usage_status": "string",
    "termination_date": "2026-07-15T08:30:00.000Z",
    "device_plan": "string",
    "billing_tag": "string",
    "so_number": "string",
    "agreement_length_months": 42.5,
    "subscription_price": 42.5,
    "data_plan_mb": 42.5,
    "sim_type": "string",
    "is_streamax_v3": true,
    "has_pending_media": true,
    "acc_status": {},
    "finance": {},
    "config_template_id": "con_9c3f21a08b",
    "config_template_status": "string",
    "config_odometer_status": "string",
    "last_config_template_applied_at": "2026-07-15T08:30:00.000Z",
    "last_odometer_update_at": "2026-07-15T08:30:00.000Z",
    "pending_commands": [
      "string"
    ],
    "protocol": "string",
    "address": "123 Main St",
    "address_color": "string",
    "face_channel": 42.5,
    "installer_email": "string",
    "custom_fields": {},
    "device_plan_configuration": {},
    "streamax_device_id": "str_9c3f21a08b",
    "is_tracing_enabled": true,
    "is_obd_available": true,
    "whitelist_enabled": true,
    "is_outdoor_ble": true,
    "tx_power": 42.5,
    "is_obd_engine_hours_available": true,
    "is_obd_odometer_available": true,
    "hos_enabled": true,
    "license_state": "ON",
    "license_country": "CA",
    "registration_expires_at": "2026-07-15T08:30:00.000Z",
    "switchboard_id": "swi_9c3f21a08b"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Update — PATCH /v1/devices/{id}

Partial update: send only the fields you want to change (the same writable fields as create, minus create-only ones). Returns the updated record in the same envelope as above.

Open in API Reference → · Back to top

DriversGETPOSTPATCHDELETE

Drivers (from the users collection); credentials and security state are never exposed.

drivers:read drivers:write Read drivers

Add-on callers: Narrowed to the user's viewing groups via ViewingGroups. Records with no group ids stay visible to everyone.

GETRead

List (GET /v1/drivers), query (POST /v1/drivers/query) and fetch one (GET /v1/drivers/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
first_namestring
last_namestring
usernamestringLogin username. Required on create; create-only (a username change is a separate, deferred operation). A password is auto-generated when omitted.
full_namestring, nullable
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
group_idsarray of stringGroup ids the driver belongs to. Required on create — at least one group must be supplied.
emailstring
phonestring
unitsstring
languagestring
user_typestring
skill_tagsarray of string
working_hoursobjectPer-day working-hours schedule, forwarded as-is (e.g. { Mon: { active, hours: { from, to } }, … }).
created_atstring (date-time)
last_loginstring (date-time)
company_idstring
license_numberstring
license_statestring
license_countrystring
time_zonestring
photo_urlstring
telegram_chat_idstring
region_idsarray of string
business_group_idsarray of string
people_group_idsarray of string
employee_idstring
can_assign_job_itselfboolean
default_viewstring
fetch_location_from_mobileboolean
feature_previewboolean
supervisor_idsarray of string
driver_app_dataobject, nullableDriver app data — check-in/out, breaks, work-time tracking, forwarded as-is.
map_providerstring
custom_fieldsobjectTenant-defined custom field values, keyed by field name, forwarded as-is.
driver_identificationstring
verification_phone_numberstring
show_self_databoolean
commentsstring
live_notification_settingsobject, nullableLive-notification preferences, forwarded as-is.
switchboard_idstring
hos_enabledboolean
hos_exemptedboolean
rule_setstring
us_hos_cyclestring
home_terminal_namestring
home_terminal_addressobject, nullableHome-terminal location ({ Location: { latitude, longitude }, LocationName }), forwarded as-is.
exemption_annotationstring
yard_move_allowedboolean
personal_conveyance_allowedboolean
pinned_add_in_idsarray of string
is_driverboolean
Relationships (?include=)

Expand with ?include=x,y.

NameExpands toNotes
groupsArray of GroupsArray of Groups (empty if none)
Filters

Filter via POST /v1/drivers/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
first_nameeq in contains starts_withString (case-insensitive).
last_nameeq in contains starts_withString (case-insensitive).
usernameeq in contains starts_withString (case-insensitive).
group_idseq inArray of string (exact match).
emaileq in contains starts_withString (case-insensitive).
phoneeq in contains starts_withString (case-insensitive).
unitseq in contains starts_withString (case-insensitive).
languageeq in contains starts_withString (case-insensitive).
user_typeeq in contains starts_withString (case-insensitive). Values: Driver, End Customer, EndUser, General User, Passenger, Technician.
skill_tagseq inArray of string (exact match).
created_ateq in gte lte betweenDate (exact match).
last_logineq in gte lte betweenDate (exact match).
company_ideq in contains starts_withString (exact match).
license_numbereq in contains starts_withString (case-insensitive).
license_stateeq in contains starts_withString (case-insensitive).
license_countryeq in contains starts_withString (case-insensitive).

Example

POST /v1/drivers/query
{
  "filters": {
    "user_type": "Driver",
    "id": {
      "in": [
        "drv_5f8a1c2b9e",
        "drv_9c3f21a08b"
      ]
    },
    "created_at": {
      "gte": "2026-07-15T08:30:00.000Z"
    },
    "first_name": {
      "contains": "Jane"
    }
  },
  "sort": "created_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (username, group_id) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "drv_5f8a1c2b9e",
      "first_name": "Jane",
      "last_name": "Doe",
      "username": "jdoe",
      "full_name": "string",
      "group_ids": [
        "grp_1a2b3c4d5e"
      ],
      "email": "jdoe@example.com",
      "phone": "+1-555-0142",
      "units": "metric",
      "language": "en",
      "user_type": "string",
      "skill_tags": [
        "hazmat"
      ],
      "working_hours": {},
      "created_at": "2026-07-15T08:30:00.000Z",
      "last_login": "2026-07-15T08:30:00.000Z",
      "company_id": "acme",
      "license_number": "D1234-56789",
      "license_state": "ON",
      "license_country": "CA",
      "time_zone": "string",
      "photo_url": "string",
      "telegram_chat_id": "tel_9c3f21a08b",
      "region_ids": [
        "string"
      ],
      "business_group_ids": [
        "string"
      ],
      "people_group_ids": [
        "string"
      ],
      "employee_id": "emp_9c3f21a08b",
      "can_assign_job_itself": true,
      "default_view": "string",
      "fetch_location_from_mobile": true,
      "feature_preview": true,
      "supervisor_ids": [
        "string"
      ],
      "driver_app_data": {},
      "map_provider": "string",
      "custom_fields": {},
      "driver_identification": "string",
      "verification_phone_number": "string",
      "show_self_data": true,
      "comments": "string",
      "live_notification_settings": {},
      "switchboard_id": "swi_9c3f21a08b",
      "hos_enabled": true,
      "hos_exempted": true,
      "rule_set": "string",
      "us_hos_cycle": "string",
      "home_terminal_name": "string",
      "home_terminal_address": {},
      "exemption_annotation": "string",
      "yard_move_allowed": true,
      "personal_conveyance_allowed": true,
      "pinned_add_in_ids": [
        "string"
      ],
      "is_driver": true,
      "groups": [
        {
          "id": "grp_5f8a1c2b9e",
          "name": "Truck 42"
        }
      ]
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}
POST PATCH DELETEWrite

drivers:write Requires the write scope. All request/response bodies use the standard { data, meta } envelope.

Create — POST /v1/drivers

Required: username, group_ids. Full request body — every writable field (send only what you need; the required fields must be present):

{
  "first_name": "string",
  "last_name": "string",
  "username": "string",
  "group_ids": [
    "string"
  ],
  "email": "string",
  "phone": "string",
  "units": "string",
  "language": "string",
  "user_type": "string",
  "working_hours": {
    "Mon": {
      "active": true,
      "hours": {
        "from": "09:00",
        "to": "17:00"
      }
    }
  },
  "license_number": "string",
  "license_state": "string",
  "license_country": "string",
  "password": "string",
  "time_zone": "string",
  "photo_url": "string",
  "region_ids": [
    "string"
  ],
  "business_group_ids": [
    "string"
  ],
  "people_group_ids": [
    "string"
  ],
  "employee_id": "string",
  "can_assign_job_itself": true,
  "default_view": "string",
  "fetch_location_from_mobile": true,
  "feature_preview": true,
  "supervisor_ids": [
    "string"
  ],
  "driver_app_data": {},
  "map_provider": "string",
  "custom_fields": {},
  "driver_identification": "string",
  "show_self_data": true,
  "comments": "string",
  "live_notification_settings": {},
  "hos_enabled": true,
  "hos_exempted": true,
  "rule_set": "string",
  "us_hos_cycle": "string",
  "home_terminal_name": "string",
  "home_terminal_address": {
    "Location": {
      "latitude": 43.6532,
      "longitude": -79.3832
    },
    "LocationName": "Main Depot"
  },
  "exemption_annotation": "string",
  "yard_move_allowed": true,
  "personal_conveyance_allowed": true,
  "pinned_add_in_ids": [
    "string"
  ]
}
Response
{
  "data": {
    "id": "drv_5f8a1c2b9e",
    "first_name": "Jane",
    "last_name": "Doe",
    "username": "jdoe",
    "full_name": "string",
    "group_ids": [
      "grp_1a2b3c4d5e"
    ],
    "email": "jdoe@example.com",
    "phone": "+1-555-0142",
    "units": "metric",
    "language": "en",
    "user_type": "string",
    "skill_tags": [
      "hazmat"
    ],
    "working_hours": {},
    "created_at": "2026-07-15T08:30:00.000Z",
    "last_login": "2026-07-15T08:30:00.000Z",
    "company_id": "acme",
    "license_number": "D1234-56789",
    "license_state": "ON",
    "license_country": "CA",
    "time_zone": "string",
    "photo_url": "string",
    "telegram_chat_id": "tel_9c3f21a08b",
    "region_ids": [
      "string"
    ],
    "business_group_ids": [
      "string"
    ],
    "people_group_ids": [
      "string"
    ],
    "employee_id": "emp_9c3f21a08b",
    "can_assign_job_itself": true,
    "default_view": "string",
    "fetch_location_from_mobile": true,
    "feature_preview": true,
    "supervisor_ids": [
      "string"
    ],
    "driver_app_data": {},
    "map_provider": "string",
    "custom_fields": {},
    "driver_identification": "string",
    "verification_phone_number": "string",
    "show_self_data": true,
    "comments": "string",
    "live_notification_settings": {},
    "switchboard_id": "swi_9c3f21a08b",
    "hos_enabled": true,
    "hos_exempted": true,
    "rule_set": "string",
    "us_hos_cycle": "string",
    "home_terminal_name": "string",
    "home_terminal_address": {},
    "exemption_annotation": "string",
    "yard_move_allowed": true,
    "personal_conveyance_allowed": true,
    "pinned_add_in_ids": [
      "string"
    ],
    "is_driver": true
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Update — PATCH /v1/drivers/{id}

Partial update: send only the fields you want to change (the same writable fields as create, minus create-only ones). Returns the updated record in the same envelope as above.

Delete — DELETE /v1/drivers/{id}

Removes the record. Returns the deleted record's id.

Open in API Reference → · Back to top

TripsGET

Completed trips (distance, durations, speed), tenant-scoped through the owning device.

trips:read Read trips

Add-on callers: Narrowed through the owning device (DeviceId). Records whose device has no group ids stay visible to everyone.

  • Supports from/to; default last 30 days, max 31-day span.
GETRead

List (GET /v1/trips), query (POST /v1/trips/query) and fetch one (GET /v1/trips/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
device_idstring
driver_idstring
start_timestring (date-time)
end_timestring (date-time)
distance_kmnumber
idling_secondsnumber, nullable
stop_secondsnumber, nullable
max_speed_kmhnumber
start_coordinatesobject, nullableGPS position. null when not resolvable.
end_coordinatesobject, nullableGPS position. null when not resolvable.
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
start_positionstring
end_positionstring
bounding_boxstring
start_address_countrystring
start_address_statestring
stop_addressstring
stop_seconds_on_startstring
geotab_idstring
ifta_report_group_idstring
Relationships (?include=)

Expand with ?include=x,y.

NameExpands toNotes
deviceDevicesDevices object (null if none)
driverDriversDrivers object (null if none)
Filters

Filter via POST /v1/trips/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
device_ideq in contains starts_withString (exact match).
driver_ideq in contains starts_withString (exact match).
start_timeeq in gte lte betweenDate (exact match).
end_timeeq in gte lte betweenDate (exact match).
distance_kmeq in gte lte betweenNumber (exact match).
idling_secondseq in gte lte betweenNumber (exact match).
stop_secondseq in gte lte betweenNumber (exact match).
max_speed_kmheq in gte lte betweenNumber (exact match).
start_address_countryeq in contains starts_withString (case-insensitive).
start_address_stateeq in contains starts_withString (case-insensitive).
stop_addresseq in contains starts_withString (case-insensitive).
stop_seconds_on_starteq in gte lte betweenNumber (exact match).

Example

POST /v1/trips/query
{
  "filters": {
    "id": {
      "in": [
        "trp_5f8a1c2b9e",
        "trp_9c3f21a08b"
      ]
    },
    "start_time": {
      "gte": "2026-07-15T08:30:00.000Z"
    },
    "device_id": {
      "contains": "dvc_5f8a1c2b9e"
    }
  },
  "sort": "start_time:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (device_id, driver_id) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "trp_5f8a1c2b9e",
      "device_id": "dvc_5f8a1c2b9e",
      "driver_id": "drv_7a1e4c8f02",
      "start_time": "2026-07-15T08:30:00.000Z",
      "end_time": "2026-07-15T08:30:00.000Z",
      "distance_km": 42.5,
      "idling_seconds": 42.5,
      "stop_seconds": 42.5,
      "max_speed_kmh": 96.3,
      "start_coordinates": {
        "latitude": 43.6532,
        "longitude": -79.3832
      },
      "end_coordinates": {
        "latitude": 43.6532,
        "longitude": -79.3832
      },
      "start_position": "string",
      "end_position": "string",
      "bounding_box": "string",
      "start_address_country": "string",
      "start_address_state": "string",
      "stop_address": "string",
      "stop_seconds_on_start": "string",
      "geotab_id": "geo_9c3f21a08b",
      "ifta_report_group_id": "ift_9c3f21a08b",
      "device": {
        "id": "dvc_5f8a1c2b9e",
        "name": "Truck 42",
        "serial": "SN-88213047"
      },
      "driver": {
        "id": "drv_5f8a1c2b9e",
        "first_name": "Jane",
        "last_name": "Doe",
        "username": "jdoe"
      }
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

Safety eventsGET

Rule violations / safety exceptions with derived handling status.

safety:read Read safety events

Add-on callers: Narrowed through the owning device (DeviceId). Records whose device has no group ids stay visible to everyone.

  • Supports from/to; default last 30 days, max 31-day span.
GETRead

List (GET /v1/safety-events), query (POST /v1/safety-events/query) and fetch one (GET /v1/safety-events/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
device_idstring
driver_idstring
rule_idstring
occurred_atstring (date-time)
ended_atstring (date-time)
speed_kmhnumber
statusstring, nullable
typestring, nullableNormalized safety-event category. Derived from the raw event string (camera/AI events) or, for rule-engine events (speeding, idling, zone, fault), the linked rule's condition — so map THIS field, not rule/severity, which are null for camera events. crash is a confirmed impact; forward-collision and headway warnings are following_distance, not crash. x-extensible-enum lists the explicitly-categorised values; any other event is returned as a snake_cased form of its raw event (e.g. lens_covered) rather than a blanket other, so the set is open.
severitystring, nullable
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
latitudenumber
longitudenumber
road_speed_limit_kmhnumber
odometer_kmnumber
engine_hoursnumber
zone_idstring
commentstring
eventstring
event_classstring
geotab_idstring
parent_device_idstring
usernamestring
dismiss_statenumber
is_handledboolean
notify_stateobject, nullableDeprecated notification-state payload, forwarded as-is.
viewedboolean
starredboolean
engine_codestring
errors_descriptionarray of string
indoor_positionobject, nullableIndoor position (BLE beacon events). null when not applicable.
linked_exceptionsarray of object
channelsstring
job_idstring
stop_idstring
video_statusobject, nullableStatus of a pending/failed video-clip request. null when no request is in flight or has ever completed.
review_issue_idstring
review_issue_tag_idsarray of string
review_reviewerstring
review_datestring (date-time), nullable
review_coach_commentstring
review_coached_user_idstring
review_coach_datestring (date-time), nullable
review_coach_user_idstring
videoarray of objectCamera clips for the event. Each element is one camera channel's recording of the event.
Relationships (?include=)

Expand with ?include=x,y.

NameExpands toNotes
deviceDevicesDevices object (null if none)
driverDriversDrivers object (null if none)
ruleRulesRules object (null if none)
zoneZonesZones object (null if none)
Filters

Filter via POST /v1/safety-events/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
device_ideq in contains starts_withString (exact match).
driver_ideq in contains starts_withString (exact match).
rule_ideq in contains starts_withString (exact match).
occurred_ateq in gte lte betweenDate (exact match).
ended_ateq in gte lte betweenDate (exact match).
speed_kmheq in gte lte betweenNumber (exact match).
statuseq inString (case-insensitive). Values: Needs Review, Needs Coaching.
latitudeeq in gte lte betweenNumber (exact match).
longitudeeq in gte lte betweenNumber (exact match).
road_speed_limit_kmheq in gte lte betweenNumber (exact match).
odometer_kmeq in gte lte betweenNumber (exact match).
engine_hourseq in gte lte betweenNumber (exact match).
zone_ideq in contains starts_withString (exact match).
commenteq in contains starts_withString (case-insensitive).
eventeq in contains starts_withString (case-insensitive).
event_classeq in contains starts_withString (case-insensitive).

Example

POST /v1/safety-events/query
{
  "filters": {
    "status": "Needs Review",
    "id": {
      "in": [
        "evt_5f8a1c2b9e",
        "evt_9c3f21a08b"
      ]
    },
    "occurred_at": {
      "gte": "2026-07-15T08:30:00.000Z"
    },
    "device_id": {
      "contains": "dvc_5f8a1c2b9e"
    }
  },
  "sort": "occurred_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (device_id, driver_id, rule_id, zone_id, status) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "evt_5f8a1c2b9e",
      "device_id": "dvc_5f8a1c2b9e",
      "driver_id": "drv_7a1e4c8f02",
      "rule_id": "rl_88af0c3e21",
      "occurred_at": "2026-07-15T08:30:00.000Z",
      "ended_at": "2026-07-15T08:30:00.000Z",
      "speed_kmh": 64.2,
      "status": "Active",
      "type": "string",
      "severity": "string",
      "latitude": 43.6532,
      "longitude": -79.3832,
      "road_speed_limit_kmh": 100,
      "odometer_km": 104532.7,
      "engine_hours": 42.5,
      "zone_id": "zn_3c9d2a1b55",
      "comment": "string",
      "event": "string",
      "event_class": "string",
      "geotab_id": "geo_9c3f21a08b",
      "parent_device_id": "par_9c3f21a08b",
      "username": "jdoe",
      "dismiss_state": 42.5,
      "is_handled": true,
      "notify_state": {},
      "viewed": true,
      "starred": true,
      "engine_code": "string",
      "errors_description": [
        "string"
      ],
      "indoor_position": {
        "x": 42.5,
        "y": 42.5,
        "map_id": "map_9c3f21a08b"
      },
      "linked_exceptions": [
        {
          "exception_id": "exc_9c3f21a08b",
          "rule_id": "rl_88af0c3e21"
        }
      ],
      "channels": "string",
      "job_id": "job_9c3f21a08b",
      "stop_id": "sto_9c3f21a08b",
      "video_status": {
        "request_status": "string",
        "error": "string",
        "date": "2026-07-15T08:30:00.000Z"
      },
      "review_issue_id": "rev_9c3f21a08b",
      "review_issue_tag_ids": [
        "string"
      ],
      "review_reviewer": "string",
      "review_date": "2026-07-15T08:30:00.000Z",
      "review_coach_comment": "string",
      "review_coached_user_id": "rev_9c3f21a08b",
      "review_coach_date": "2026-07-15T08:30:00.000Z",
      "review_coach_user_id": "rev_9c3f21a08b",
      "video": [
        {
          "channel": 3,
          "facing": "forward",
          "url": "https://cdn.example.com/clip.mp4",
          "screenshot_url": "https://cdn.example.com/clip.jpg",
          "starts_at": "2026-07-15T08:30:00.000Z",
          "ends_at": "2026-07-15T08:30:00.000Z",
          "ai_video_url": "https://cdn.example.com/clip-ai.mp4",
          "video_id": "vid_9f31a0c2",
          "mdt_url": "string",
          "short_screenshot_url": "string"
        }
      ],
      "device": {
        "id": "dvc_5f8a1c2b9e",
        "name": "Truck 42",
        "serial": "SN-88213047"
      },
      "driver": {
        "id": "drv_5f8a1c2b9e",
        "first_name": "Jane",
        "last_name": "Doe",
        "username": "jdoe"
      },
      "rule": {
        "id": "rl_5f8a1c2b9e",
        "name": "Truck 42",
        "description": "Sample description.",
        "is_active": true,
        "score": 42.5,
        "severity_band": "string",
        "color": "#2188D9",
        "rule_type": "Speed",
        "trigger_type": "Threshold",
        "condition_types": [
          "Speed"
        ],
        "condition": null
      },
      "zone": {
        "id": "zn_5f8a1c2b9e",
        "name": "Truck 42",
        "type": "string"
      }
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

RulesGET

Safety rule definitions.

rules:read Read rules

Add-on callers: Narrowed to the user's viewing groups via GroupsIds. Records with no group ids stay visible to everyone.

GETRead

List (GET /v1/rules), query (POST /v1/rules/query) and fetch one (GET /v1/rules/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
namestring
descriptionstring
is_activeboolean
scorenumber
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
group_idsarray of string
colorstring
custom_messagestring
notification_periodstring
severity_bandstring
rule_typestring
trigger_typestring
condition_typesarray of stringRaw (non-normalized) condition leaf types found anywhere in the rule's condition tree, e.g. ["Speed"]. Includes the type from a rule's deprecated single-condition form even when condition returns only the newer tree, so an entry here may have no counterpart in condition.
conditionRuleConditionNodeThe rule's condition tree. null when the rule has no conditions.
company_idstring
is_readonlyboolean
device_idsarray of string
driver_idsarray of string
escalationsarray of objectEscalation steps (Id, Delay, DisplayDelay, DisplayDelayType, Name, UserId), forwarded as-is.
notificationsarray of objectNotification routing rules (Id, EventType, EmailTo, CustomEmails, SmsTo, CustomPhone, MessageSubject, MessageBody, TtsLanguage, TtsAudioFileId, TtsMessage, WebhookUrl, CommandChannels, CommandAction), forwarded as-is.
notify_by_smsboolean
notify_by_callboolean
request_form_submissionboolean
form_idstring
attach_videoboolean
attach_video_enabled_atstring (date-time)
download_channelsarray of number
use_snapshotsboolean
use_snapshots_enabled_atstring (date-time)
snapshot_time_lengthnumber
remindobjectMaintenance-reminder detail (RemindDate, RemindMileage, Decription, DevicesIds), forwarded as-is.
managed_reviewboolean
coachesarray of string
action_dataobjectMaintenance trigger/form action data, forwarded as-is.
is_generalboolean
is_direct_coaching_enabledboolean
notify_driverboolean
rule_actionarray of objectConfigured rule actions (Enabled, Type, TargetGroupId), forwarded as-is.
Relationships (?include=)

Expand with ?include=x,y.

NameExpands toNotes
groupsArray of GroupsArray of Groups (empty if none)
Filters

Filter via POST /v1/rules/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
nameeq in contains starts_withString (case-insensitive). Discover valid values via GET /v1/rules.
descriptioneq in contains starts_withString (case-insensitive).
is_activeeqBoolean (exact match).
scoreeq in gte lte betweenNumber (exact match).
group_idseq inArray of string (exact match).
coloreq in contains starts_withString (case-insensitive).
custom_messageeq in contains starts_withString (case-insensitive).
notification_periodeq in contains starts_withString (case-insensitive).
rule_typeeq in contains starts_withString (case-insensitive). Values: CameraSafety, CustomSafety, GeneralSafety.
trigger_typeeq in contains starts_withString (case-insensitive).

Example

POST /v1/rules/query
{
  "filters": {
    "rule_type": "CameraSafety",
    "id": {
      "in": [
        "rl_5f8a1c2b9e",
        "rl_9c3f21a08b"
      ]
    },
    "score": {
      "gte": 42.5
    },
    "name": {
      "contains": "Truck"
    }
  },
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (group_id, is_active) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "rl_5f8a1c2b9e",
      "name": "Truck 42",
      "description": "Sample description.",
      "is_active": true,
      "score": 42.5,
      "group_ids": [
        "grp_1a2b3c4d5e"
      ],
      "color": "#2188D9",
      "custom_message": "Speeding detected",
      "notification_period": "Immediate",
      "severity_band": "string",
      "rule_type": "Speed",
      "trigger_type": "Threshold",
      "condition_types": [
        "Speed"
      ],
      "condition": null,
      "company_id": "acme",
      "is_readonly": true,
      "device_ids": [
        "string"
      ],
      "driver_ids": [
        "string"
      ],
      "escalations": [
        {}
      ],
      "notifications": [
        {}
      ],
      "notify_by_sms": true,
      "notify_by_call": true,
      "request_form_submission": true,
      "form_id": "for_9c3f21a08b",
      "attach_video": true,
      "attach_video_enabled_at": "2026-07-15T08:30:00.000Z",
      "download_channels": [
        42.5
      ],
      "use_snapshots": true,
      "use_snapshots_enabled_at": "2026-07-15T08:30:00.000Z",
      "snapshot_time_length": 42.5,
      "remind": {},
      "managed_review": true,
      "coaches": [
        "string"
      ],
      "action_data": {},
      "is_general": true,
      "is_direct_coaching_enabled": true,
      "notify_driver": true,
      "rule_action": [
        {}
      ],
      "groups": [
        {
          "id": "grp_5f8a1c2b9e",
          "name": "Truck 42"
        }
      ]
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

ZonesGETPOSTPATCHDELETE

Geofences / zones.

zones:read zones:write Read zones / geofences

Add-on callers: Narrowed to the user's viewing groups via GroupIds. Records with no group ids stay visible to everyone.

GETRead

List (GET /v1/zones), query (POST /v1/zones/query) and fetch one (GET /v1/zones/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
namestring
typestringThe zone's tag, stored as a tag id (UUID) — not a shape or free-text category. Required on create.
colorstringZone display colour as a hex string, e.g. #2f80ed. Required on create.
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
group_idsarray of string
addressstring
citystring
countrystring
postal_codestring
street_addressstring
geometryobject, nullableOutdoor zone shape, forwarded as-is in PascalCase. Either a circle { "Type": "circle", "Center": { "Latitude": <n>, "Longitude": <n> }, "Radius": <n> } or a polygon { "Type": "polygon", "Points": [ { "Latitude": <n>, "Longitude": <n> }, … (min 3) ] }. Type must be lowercase circle or polygon. Provide EITHER geometry (outdoor, lat/lng) OR indoor_geometry + indoor_map_id (indoor) — never both.
open_fromstring
open_tostring
expected_stop_secondsnumber
created_atstring (date-time)
company_idstring
tag_idstring
instructionsstring
address_notesstring
statestring
contact_namestring
contact_emailstring
phonestring
account_idstring
customobject, nullableTenant-defined custom data for integrations, keyed by field name (string or number values), forwarded as-is. null when not set.
indoor_geometryobject, nullableIndoor zone shape on an uploaded indoor map, forwarded as-is in PascalCase (uses Center.X/Center.Y, not latitude/longitude). Requires indoor_map_id. Mutually exclusive with geometry; null for outdoor zones.
indoor_map_idstring, nullableId of the indoor map an indoor zone belongs to. Required when indoor_geometry is set; must be omitted for outdoor (geometry) zones — sending it on an outdoor zone is rejected with "Outdoor zone can't have indoor map id".
expirystring (date-time), nullableZone expiration date — the collection has a TTL index that deletes expired zones. null when the zone doesn't expire.
transparencynumberMap rendering opacity, in percent (0-100).
unit_numberstring
geotab_idstring
Relationships (?include=)

Expand with ?include=x,y.

NameExpands toNotes
groupsArray of GroupsArray of Groups (empty if none)
Filters

Filter via POST /v1/zones/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
nameeq in contains starts_withString (case-insensitive). Discover valid values via GET /v1/zones.
typeeq in contains starts_withString (case-insensitive). Discover valid values via GET /v1/zones.
coloreq in contains starts_withString (case-insensitive).
group_idseq inArray of string (exact match).
addresseq in contains starts_withString (case-insensitive).
cityeq in contains starts_withString (case-insensitive).
countryeq in contains starts_withString (case-insensitive).
postal_codeeq in contains starts_withString (case-insensitive).
street_addresseq in contains starts_withString (case-insensitive).
expected_stop_secondseq in gte lte betweenNumber (exact match).

Example

POST /v1/zones/query
{
  "filters": {
    "id": {
      "in": [
        "zn_5f8a1c2b9e",
        "zn_9c3f21a08b"
      ]
    },
    "expected_stop_seconds": {
      "gte": 42.5
    },
    "name": {
      "contains": "Truck"
    }
  },
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (group_id, type, name) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "zn_5f8a1c2b9e",
      "name": "Truck 42",
      "type": "string",
      "color": "#2188D9",
      "group_ids": [
        "grp_1a2b3c4d5e"
      ],
      "address": "123 Main St",
      "city": "Toronto",
      "country": "CA",
      "postal_code": "M5V 2T6",
      "street_address": "123 Main St",
      "geometry": {},
      "open_from": "string",
      "open_to": "string",
      "expected_stop_seconds": 42.5,
      "created_at": "2026-07-15T08:30:00.000Z",
      "company_id": "acme",
      "tag_id": "tag_9c3f21a08b",
      "instructions": "string",
      "address_notes": "string",
      "state": "string",
      "contact_name": "string",
      "contact_email": "string",
      "phone": "+1-555-0142",
      "account_id": "acc_9c3f21a08b",
      "custom": {
        "sample": "string"
      },
      "indoor_geometry": {},
      "indoor_map_id": "ind_9c3f21a08b",
      "expiry": "2026-07-15T08:30:00.000Z",
      "transparency": 42.5,
      "unit_number": "string",
      "geotab_id": "geo_9c3f21a08b",
      "groups": [
        {
          "id": "grp_5f8a1c2b9e",
          "name": "Truck 42"
        }
      ]
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}
POST PATCH DELETEWrite

zones:write Requires the write scope. All request/response bodies use the standard { data, meta } envelope.

Create — POST /v1/zones

Required: name, type, color. Full request body — every writable field (send only what you need; the required fields must be present):

{
  "name": "string",
  "type": "string",
  "color": "string",
  "group_ids": [
    "string"
  ],
  "address": "string",
  "city": "string",
  "country": "string",
  "postal_code": "string",
  "street_address": "string",
  "geometry": {
    "Type": "circle",
    "Center": {
      "Latitude": 43.6532,
      "Longitude": -79.3832
    },
    "Radius": 200
  },
  "open_from": "string",
  "open_to": "string",
  "expected_stop_seconds": 0,
  "tag_id": "string",
  "instructions": "string",
  "address_notes": "string",
  "state": "string",
  "contact_name": "string",
  "contact_email": "string",
  "phone": "string",
  "account_id": "string",
  "custom": {},
  "indoor_geometry": {
    "Type": "circle",
    "Center": {
      "X": 120,
      "Y": 240
    },
    "Radius": 30
  },
  "indoor_map_id": "string",
  "expiry": "2026-01-01T00:00:00Z",
  "transparency": 0,
  "unit_number": "string"
}
Response
{
  "data": {
    "id": "zn_5f8a1c2b9e",
    "name": "Truck 42",
    "type": "string",
    "color": "#2188D9",
    "group_ids": [
      "grp_1a2b3c4d5e"
    ],
    "address": "123 Main St",
    "city": "Toronto",
    "country": "CA",
    "postal_code": "M5V 2T6",
    "street_address": "123 Main St",
    "geometry": {},
    "open_from": "string",
    "open_to": "string",
    "expected_stop_seconds": 42.5,
    "created_at": "2026-07-15T08:30:00.000Z",
    "company_id": "acme",
    "tag_id": "tag_9c3f21a08b",
    "instructions": "string",
    "address_notes": "string",
    "state": "string",
    "contact_name": "string",
    "contact_email": "string",
    "phone": "+1-555-0142",
    "account_id": "acc_9c3f21a08b",
    "custom": {
      "sample": "string"
    },
    "indoor_geometry": {},
    "indoor_map_id": "ind_9c3f21a08b",
    "expiry": "2026-07-15T08:30:00.000Z",
    "transparency": 42.5,
    "unit_number": "string",
    "geotab_id": "geo_9c3f21a08b"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Update — PATCH /v1/zones/{id}

Partial update: send only the fields you want to change (the same writable fields as create, minus create-only ones). Returns the updated record in the same envelope as above.

Delete — DELETE /v1/zones/{id}

Removes the record. Returns the deleted record's id.

Open in API Reference → · Back to top

GroupsGETPOSTPATCHDELETE

The group hierarchy used to scope and filter every other entity.

groups:read groups:write Read groups

Add-on callers: Narrowed to the groups the user themselves holds.

GETRead

List (GET /v1/groups), query (POST /v1/groups/query) and fetch one (GET /v1/groups/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
namestringGroup name. Required on create.
child_idsarray of string, nullable
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
image_urlstring
company_idstring
geotab_idstring
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/groups/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
nameeq in contains starts_withString (case-insensitive). Discover valid values via GET /v1/groups.
child_idseq inArray of string (exact match).
image_urleq in contains starts_withString (case-insensitive).

Example

POST /v1/groups/query
{
  "filters": {
    "id": {
      "in": [
        "grp_5f8a1c2b9e",
        "grp_9c3f21a08b"
      ]
    },
    "name": {
      "contains": "Truck"
    }
  },
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (name) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "grp_5f8a1c2b9e",
      "name": "Truck 42",
      "child_ids": [
        "grp_2b3c4d5e6f"
      ],
      "image_url": "string",
      "company_id": "acme",
      "geotab_id": "geo_9c3f21a08b"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}
POST PATCH DELETEWrite

groups:write Requires the write scope. All request/response bodies use the standard { data, meta } envelope.

Create — POST /v1/groups

Required: name. Full request body — every writable field (send only what you need; the required fields must be present):

{
  "name": "string",
  "image_url": "string",
  "parent_id": "string"
}
Response
{
  "data": {
    "id": "grp_5f8a1c2b9e",
    "name": "Truck 42",
    "child_ids": [
      "grp_2b3c4d5e6f"
    ],
    "image_url": "string",
    "company_id": "acme",
    "geotab_id": "geo_9c3f21a08b"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Update — PATCH /v1/groups/{id}

Partial update: send only the fields you want to change (the same writable fields as create, minus create-only ones). Returns the updated record in the same envelope as above.

Delete — DELETE /v1/groups/{id}

Removes the record. Returns the deleted record's id.

Open in API Reference → · Back to top

Vehicle faultsGET

Detected vehicle faults with triage state, one row per fault raised on a device, scoped to the token's company. Status is one of New, Triaged, Assigned, WorkOrder, Active, Dismissed, Closed. The shared code catalog is embeddable via include=insight.

faults:read Read vehicle faults and the fault-code catalog

Add-on callers: Narrowed through the owning device (DeviceId). Records whose device has no group ids stay visible to everyone.

  • Supports from/to (optional, uncapped) — no default window; these rows are long-lived state, not events.
GETRead

List (GET /v1/faults), query (POST /v1/faults/query) and fetch one (GET /v1/faults/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
device_idstring
codestring
statusstring
severitystring
titlestring
detected_onstring (date-time)
created_atstring (date-time)
reoccurrence_countnumber
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
descriptionstring
categorystring
issue_sourcestring
last_updated_atstring (date-time)
closed_atstring (date-time)
assigned_tostring
work_order_idstring
service_request_numbernumber
fault_idstring
timelinearray of objectFault triage timeline entries (reported/triaged/assigned/closed/reopened/comment/linked_wo), forwarded as-is.
attachmentsarray of objectAttached files ({Url, Name}), forwarded as-is.
closed_bystring
watcher_idsarray of string
company_idstring
Relationships (?include=)

Expand with ?include=x,y.

NameExpands toNotes
deviceDevicesDevices object (null if none)
insightFault codesFault codes object (null if none)
Filters

Filter via POST /v1/faults/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
device_ideq in contains starts_withString (exact match).
codeeq in contains starts_withString (case-insensitive).
statuseq in contains starts_withString (case-insensitive).
severityeq in contains starts_withString (case-insensitive).
titleeq in contains starts_withString (case-insensitive).
detected_oneq in gte lte betweenDate (exact match).
created_ateq in gte lte betweenDate (exact match).
reoccurrence_counteq in gte lte betweenNumber (exact match).
descriptioneq in contains starts_withString (case-insensitive).
categoryeq in contains starts_withString (case-insensitive).
issue_sourceeq in contains starts_withString (case-insensitive).
last_updated_ateq in gte lte betweenDate (exact match).
closed_ateq in gte lte betweenDate (exact match).
assigned_toeq in contains starts_withString (case-insensitive).
work_order_ideq in contains starts_withString (exact match).
service_request_numbereq in gte lte betweenNumber (exact match).
fault_ideq in contains starts_withString (exact match).

Example

POST /v1/faults/query
{
  "filters": {
    "id": {
      "in": [
        "flt_5f8a1c2b9e",
        "flt_9c3f21a08b"
      ]
    },
    "detected_on": {
      "gte": "2026-07-15T08:30:00.000Z"
    },
    "device_id": {
      "contains": "dvc_5f8a1c2b9e"
    }
  },
  "sort": "created_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (device_id, code, status, severity) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "flt_5f8a1c2b9e",
      "device_id": "dvc_5f8a1c2b9e",
      "code": "P0171",
      "status": "Active",
      "severity": "string",
      "title": "Check engine light",
      "detected_on": "2026-07-15T08:30:00.000Z",
      "created_at": "2026-07-15T08:30:00.000Z",
      "reoccurrence_count": 42.5,
      "description": "Sample description.",
      "category": "Engine",
      "issue_source": "OBD",
      "last_updated_at": "2026-07-15T08:30:00.000Z",
      "closed_at": "2026-07-15T08:30:00.000Z",
      "assigned_to": "Jane Doe",
      "work_order_id": "wo_20394",
      "service_request_number": 42.5,
      "fault_id": "flt_4b6e9a0d77",
      "timeline": [
        {}
      ],
      "attachments": [
        {}
      ],
      "closed_by": "string",
      "watcher_ids": [
        "string"
      ],
      "company_id": "acme",
      "device": {
        "id": "dvc_5f8a1c2b9e",
        "name": "Truck 42",
        "serial": "SN-88213047"
      },
      "insight": {
        "code": "P0171",
        "component": "Fuel System",
        "severity": "string",
        "summary": "System running too lean.",
        "description": "Sample description.",
        "source": "OEM",
        "detected_symptoms": [
          "Check engine light on"
        ],
        "recommended_actions": [
          "Inspect wiring harness"
        ],
        "most_likely_root_cause": {
          "cause": "Loose gas cap",
          "confidence_level": 82
        },
        "potential_impact": [
          "Reduced fuel efficiency"
        ],
        "manufacturer": "Ford",
        "model": "F-150",
        "make_year": "string"
      }
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

Fault codesGET

Global, AI-enriched diagnostic-code catalog (shared reference data; no tenant scoping).

faults:read Read vehicle faults and the fault-code catalog

Add-on callers: Not group-scoped — Cross-tenant fault-code catalog (global: true).

GETRead

List (GET /v1/fault-codes), query (POST /v1/fault-codes/query) and fetch one (GET /v1/fault-codes/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
codestring
componentstring
severitystring
summarystring
sourcestring
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
descriptionstring
detected_symptomsarray of string
recommended_actionsarray of string
most_likely_root_causeobject, nullableAI-assessed most likely root cause. null when the catalog row has no assessment.
potential_impactarray of string
manufacturerstring
modelstring
protocolstring
make_yearstring
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/fault-codes/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
codeeq in contains starts_withString (case-insensitive).
componenteq in contains starts_withString (case-insensitive).
severityeq in contains starts_withString (case-insensitive). Values: Low, Moderate, High, Critical.
summaryeq in contains starts_withString (case-insensitive).
sourceeq in contains starts_withString (case-insensitive).
descriptioneq in contains starts_withString (case-insensitive).
detected_symptomseq inArray of string (exact match).
recommended_actionseq inArray of string (exact match).
potential_impacteq inArray of string (exact match).
manufacturereq in contains starts_withString (case-insensitive).
modeleq in contains starts_withString (case-insensitive).
protocoleq in contains starts_withString (case-insensitive).
make_yeareq in gte lte betweenString (case-insensitive).

Example

POST /v1/fault-codes/query
{
  "filters": {
    "severity": "Low",
    "id": {
      "in": [
        "fc_5f8a1c2b9e",
        "fc_9c3f21a08b"
      ]
    },
    "make_year": {
      "gte": "Make year"
    },
    "code": {
      "contains": "P0171"
    }
  },
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (code, component, severity) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "fc_5f8a1c2b9e",
      "code": "P0171",
      "component": "Fuel System",
      "severity": "string",
      "summary": "System running too lean.",
      "source": "OEM",
      "description": "Sample description.",
      "detected_symptoms": [
        "Check engine light on"
      ],
      "recommended_actions": [
        "Inspect wiring harness"
      ],
      "most_likely_root_cause": {
        "cause": "Loose gas cap",
        "confidence_level": 82
      },
      "potential_impact": [
        "Reduced fuel efficiency"
      ],
      "manufacturer": "Ford",
      "model": "F-150",
      "protocol": "string",
      "make_year": "string"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

Maintenance requestsGETPOSTPATCHDELETE

Vehicle maintenance service requests.

maintenance:read maintenance:write Read maintenance requests and repair orders

Add-on callers: Narrowed through the owning device (details.asset). Records whose device has no group ids stay visible to everyone.

  • Supports from/to; default last 30 days, max 31-day span.
GETRead

List (GET /v1/maintenance-requests), query (POST /v1/maintenance-requests/query) and fetch one (GET /v1/maintenance-requests/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
service_numbernumber
statusstring
odometer_kmnumber
engine_hoursnumber
created_atstring (date-time)
resolved_atstring (date-time)
total_costnumber
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
detailsobjectMaintenance request details, forwarded as-is (camelCase sub-keys) to the maintenance service. Required on create — the request is built from this object. In practice set asset (the vehicle/device id) and a valid dueDate; the other sub-keys are optional.
labour_costnumber
parts_costnumber
service_costnumber
tagsarray of string
created_bystring
resolved_bystring
is_openboolean
company_idstring
status_changed_atstring (date-time)
sourcestring
repair_order_numbernumber
repair_order_idstring
service_provider_idstring
logged_timenumber
added_to_repairboolean
assigned_tostring
assigned_bystring
assigned_atstring (date-time)
resolved_odometer_kmnumber
resolved_engine_hoursnumber
rule_idstring
cancellation_reasonstring
completion_odometer_kmnumber
completion_engine_hoursnumber
completed_atstring (date-time)
added_productsarray of objectProduct/part line items attached to the request, forwarded as-is (camelCase sub-keys, matching the stored shape).
product_laboursstring
defectstring
submission_idsarray of string
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/maintenance-requests/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
service_numbereq in gte lte betweenNumber (exact match).
statuseq in contains starts_withString (case-insensitive). Values: Pending Assignment, Assigned, In Progress, On Hold, Completed, Cancelled.
odometer_kmeq in gte lte betweenNumber (exact match).
engine_hourseq in gte lte betweenNumber (exact match).
created_ateq in gte lte betweenDate (exact match).
resolved_ateq in gte lte betweenDate (exact match).
total_costeq in gte lte betweenNumber (exact match).
labour_costeq in gte lte betweenNumber (exact match).
parts_costeq in gte lte betweenNumber (exact match).
service_costeq in gte lte betweenNumber (exact match).
tagseq inArray of string (exact match).
created_byeq in contains starts_withString (case-insensitive).
resolved_byeq in contains starts_withString (case-insensitive).
is_openeqBoolean (exact match).

Example

POST /v1/maintenance-requests/query
{
  "filters": {
    "status": "Pending Assignment",
    "id": {
      "in": [
        "mr_5f8a1c2b9e",
        "mr_9c3f21a08b"
      ]
    },
    "service_number": {
      "gte": 42.5
    },
    "created_by": {
      "contains": "jdoe"
    }
  },
  "sort": "created_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (status) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "mr_5f8a1c2b9e",
      "service_number": 42.5,
      "status": "Active",
      "odometer_km": 104532.7,
      "engine_hours": 42.5,
      "created_at": "2026-07-15T08:30:00.000Z",
      "resolved_at": "2026-07-15T08:30:00.000Z",
      "total_cost": 42.5,
      "details": {
        "asset": "string",
        "maintenanceType": "string",
        "reference": "string",
        "dueDate": "2026-07-15T08:30:00.000Z",
        "summary": "System running too lean.",
        "priority": "string"
      },
      "labour_cost": 42.5,
      "parts_cost": 42.5,
      "service_cost": 42.5,
      "tags": [
        "priority"
      ],
      "created_by": "jdoe",
      "resolved_by": "jdoe",
      "is_open": true,
      "company_id": "acme",
      "status_changed_at": "2026-07-15T08:30:00.000Z",
      "source": "OEM",
      "repair_order_number": 42.5,
      "repair_order_id": "rep_9c3f21a08b",
      "service_provider_id": "ser_9c3f21a08b",
      "logged_time": 42.5,
      "added_to_repair": true,
      "assigned_to": "Jane Doe",
      "assigned_by": "string",
      "assigned_at": "2026-07-15T08:30:00.000Z",
      "resolved_odometer_km": 42.5,
      "resolved_engine_hours": 42.5,
      "rule_id": "rl_88af0c3e21",
      "cancellation_reason": "string",
      "completion_odometer_km": 42.5,
      "completion_engine_hours": 42.5,
      "completed_at": "2026-07-15T08:30:00.000Z",
      "added_products": [
        {
          "id": "mr_5f8a1c2b9e",
          "name": "Truck 42",
          "type": "string",
          "quantityOrHours": 42.5,
          "unitCost": 42.5,
          "totalCost": 42.5,
          "disableUnitCost": true,
          "estimatedTime": 42.5
        }
      ],
      "product_labours": "string",
      "defect": "string",
      "submission_ids": [
        "string"
      ]
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}
POST PATCH DELETEWrite

maintenance:write Requires the write scope. All request/response bodies use the standard { data, meta } envelope.

Create — POST /v1/maintenance-requests

Required: details. Full request body — every writable field (send only what you need; the required fields must be present):

{
  "status": "string",
  "details": {
    "asset": "string",
    "maintenanceType": "string",
    "reference": "string",
    "dueDate": "2026-01-01T00:00:00Z",
    "summary": "string",
    "priority": "string"
  },
  "tags": [
    "string"
  ],
  "service_provider_id": "string",
  "assigned_to": "string",
  "added_products": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "quantityOrHours": 0,
      "unitCost": 0,
      "totalCost": 0,
      "disableUnitCost": true,
      "estimatedTime": 0
    }
  ],
  "defect": "string"
}
Response
{
  "data": {
    "id": "mr_5f8a1c2b9e",
    "service_number": 42.5,
    "status": "Active",
    "odometer_km": 104532.7,
    "engine_hours": 42.5,
    "created_at": "2026-07-15T08:30:00.000Z",
    "resolved_at": "2026-07-15T08:30:00.000Z",
    "total_cost": 42.5,
    "details": {
      "asset": "string",
      "maintenanceType": "string",
      "reference": "string",
      "dueDate": "2026-07-15T08:30:00.000Z",
      "summary": "System running too lean.",
      "priority": "string"
    },
    "labour_cost": 42.5,
    "parts_cost": 42.5,
    "service_cost": 42.5,
    "tags": [
      "priority"
    ],
    "created_by": "jdoe",
    "resolved_by": "jdoe",
    "is_open": true,
    "company_id": "acme",
    "status_changed_at": "2026-07-15T08:30:00.000Z",
    "source": "OEM",
    "repair_order_number": 42.5,
    "repair_order_id": "rep_9c3f21a08b",
    "service_provider_id": "ser_9c3f21a08b",
    "logged_time": 42.5,
    "added_to_repair": true,
    "assigned_to": "Jane Doe",
    "assigned_by": "string",
    "assigned_at": "2026-07-15T08:30:00.000Z",
    "resolved_odometer_km": 42.5,
    "resolved_engine_hours": 42.5,
    "rule_id": "rl_88af0c3e21",
    "cancellation_reason": "string",
    "completion_odometer_km": 42.5,
    "completion_engine_hours": 42.5,
    "completed_at": "2026-07-15T08:30:00.000Z",
    "added_products": [
      {
        "id": "mr_5f8a1c2b9e",
        "name": "Truck 42",
        "type": "string",
        "quantityOrHours": 42.5,
        "unitCost": 42.5,
        "totalCost": 42.5,
        "disableUnitCost": true,
        "estimatedTime": 42.5
      }
    ],
    "product_labours": "string",
    "defect": "string",
    "submission_ids": [
      "string"
    ]
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Update — PATCH /v1/maintenance-requests/{id}

Partial update: send only the fields you want to change (the same writable fields as create, minus create-only ones). Returns the updated record in the same envelope as above.

Delete — DELETE /v1/maintenance-requests/{id}

Removes the record. Returns the deleted record's id.

Open in API Reference → · Back to top

Repair ordersGETPOSTPATCHDELETE

Repair orders (curated totals; raw cost breakdowns hidden).

maintenance:read maintenance:write Read maintenance requests and repair orders

Add-on callers: Narrowed through the owning device (details.asset). Records whose device has no group ids stay visible to everyone.

  • Supports from/to; default last 30 days, max 31-day span.
GETRead

List (GET /v1/repair-orders), query (POST /v1/repair-orders/query) and fetch one (GET /v1/repair-orders/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
order_numbernumber
statusstring
total_costnumber, nullable
created_atstring (date-time)
request_countnumber, nullable
service_request_idsarray of string
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
detailsobjectRepair order details, forwarded as-is (camelCase sub-keys) to the maintenance service. Required on create; in practice set asset and a valid dueDate. assignTo/serviceProvider also propagate onto the linked service requests.
assigned_atstring (date-time)
assigned_bystring
added_servicesarray of stringMaintenance service request ids attached to this repair order. Required on create: at least one id, each an existing service request in the company that is not already attached to another repair order.
company_idstring
created_bystring
resolved_bystring
resolved_atstring (date-time)
status_changed_atstring (date-time)
cancellation_reasonstring
product_laboursarray of object
estimated_timenumber
logged_timenumber
service_amountnumber
goods_amountnumber
subtotalnumber
discountobject, nullableDiscount applied to the order total. null when summary/discount isn't set.
taxobject, nullableTax applied to the order total. null when summary/tax isn't set.
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/repair-orders/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
order_numbereq in gte lte betweenNumber (exact match).
statuseq in contains starts_withString (case-insensitive). Values: Pending Assignment, Assigned, In Progress, On Hold, Completed, Cancelled.
created_ateq in gte lte betweenDate (exact match).
service_request_idseq inArray of string (exact match).
assigned_ateq in gte lte betweenDate (exact match).
assigned_byeq in contains starts_withString (case-insensitive).
added_serviceseq inArray of string (exact match).

Example

POST /v1/repair-orders/query
{
  "filters": {
    "status": "Pending Assignment",
    "id": {
      "in": [
        "ro_5f8a1c2b9e",
        "ro_9c3f21a08b"
      ]
    },
    "order_number": {
      "gte": 42.5
    },
    "assigned_by": {
      "contains": "Assigned"
    }
  },
  "sort": "created_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (status) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "ro_5f8a1c2b9e",
      "order_number": 42.5,
      "status": "Active",
      "total_cost": 42.5,
      "created_at": "2026-07-15T08:30:00.000Z",
      "request_count": 42.5,
      "service_request_ids": [
        "sr_10293"
      ],
      "details": {
        "asset": "string",
        "priority": "string",
        "assignTo": "string",
        "serviceProvider": "string",
        "summary": "System running too lean.",
        "dueDate": "2026-07-15T08:30:00.000Z",
        "reference": "string"
      },
      "assigned_at": "2026-07-15T08:30:00.000Z",
      "assigned_by": "string",
      "added_services": [
        "string"
      ],
      "company_id": "acme",
      "created_by": "jdoe",
      "resolved_by": "jdoe",
      "resolved_at": "2026-07-15T08:30:00.000Z",
      "status_changed_at": "2026-07-15T08:30:00.000Z",
      "cancellation_reason": "string",
      "product_labours": [
        {
          "id": "ro_5f8a1c2b9e",
          "name": "Truck 42"
        }
      ],
      "estimated_time": 42.5,
      "logged_time": 42.5,
      "service_amount": 42.5,
      "goods_amount": 42.5,
      "subtotal": 42.5,
      "discount": {
        "value": 42.5,
        "type": "Dollar",
        "final_value": 42.5
      },
      "tax": {
        "value": 42.5,
        "type": "Dollar",
        "final_value": 42.5
      }
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}
POST PATCH DELETEWrite

maintenance:write Requires the write scope. All request/response bodies use the standard { data, meta } envelope.

Create — POST /v1/repair-orders

Required: details, added_services. Full request body — every writable field (send only what you need; the required fields must be present):

{
  "status": "string",
  "details": {
    "asset": "string",
    "priority": "string",
    "assignTo": "string",
    "serviceProvider": "string",
    "summary": "string",
    "dueDate": "2026-01-01T00:00:00Z",
    "reference": "string"
  },
  "added_services": [
    "string"
  ]
}
Response
{
  "data": {
    "id": "ro_5f8a1c2b9e",
    "order_number": 42.5,
    "status": "Active",
    "total_cost": 42.5,
    "created_at": "2026-07-15T08:30:00.000Z",
    "request_count": 42.5,
    "service_request_ids": [
      "sr_10293"
    ],
    "details": {
      "asset": "string",
      "priority": "string",
      "assignTo": "string",
      "serviceProvider": "string",
      "summary": "System running too lean.",
      "dueDate": "2026-07-15T08:30:00.000Z",
      "reference": "string"
    },
    "assigned_at": "2026-07-15T08:30:00.000Z",
    "assigned_by": "string",
    "added_services": [
      "string"
    ],
    "company_id": "acme",
    "created_by": "jdoe",
    "resolved_by": "jdoe",
    "resolved_at": "2026-07-15T08:30:00.000Z",
    "status_changed_at": "2026-07-15T08:30:00.000Z",
    "cancellation_reason": "string",
    "product_labours": [
      {
        "id": "ro_5f8a1c2b9e",
        "name": "Truck 42"
      }
    ],
    "estimated_time": 42.5,
    "logged_time": 42.5,
    "service_amount": 42.5,
    "goods_amount": 42.5,
    "subtotal": 42.5,
    "discount": {
      "value": 42.5,
      "type": "Dollar",
      "final_value": 42.5
    },
    "tax": {
      "value": 42.5,
      "type": "Dollar",
      "final_value": 42.5
    }
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Update — PATCH /v1/repair-orders/{id}

Partial update: send only the fields you want to change (the same writable fields as create, minus create-only ones). Returns the updated record in the same envelope as above.

Delete — DELETE /v1/repair-orders/{id}

Removes the record. Returns the deleted record's id.

Open in API Reference → · Back to top

Diagnostic readingsGET

Sensor/telemetry time-series (list-only, date-cursored).

diagnostics:read Read diagnostic readings

Add-on callers: Narrowed through the owning device (DeviceId). Records whose device has no group ids stay visible to everyone.

  • Supports from/to; default last 30 days, max 31-day span.
  • Required filter(s): device_id.
  • List-only — no GET /diagnostics/{id} route.
GETRead

List (GET /v1/diagnostics), query (POST /v1/diagnostics/query) and fetch one (GET /v1/diagnostics/{id}).

Default fields

Always returned.

KeyTypeDescription
device_idstring
typestring
valuenumber
recorded_atstring (date-time)
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
text_valuestring
diffstring
sourcestring
Relationships (?include=)

Expand with ?include=x,y.

NameExpands toNotes
deviceDevicesDevices object (null if none)
Filters

Filter via POST /v1/diagnostics/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
device_ideq in contains starts_withString (exact match). Required.
typeeq in contains starts_withString (case-insensitive). Values: InDoor, OutDoor, DoorState, RemovalState, BLEConnection, Battery, Humidity, Temperature, Impact, Pressure, Light, Tamper, RSSI, Fuel, FuelLevel, Odometer, TirePressureLF, TirePressureRF, TirePressureLR, TirePressureRR, CoolantTemperature, BatteryVoltage, BackupBatteryVoltage, EngineOnTime, RPM, EngineSpeed, EngineHours, EngineLoad, TotalMileage, AverageOilConsumption, Break, OilPressure, MassAirFlow, Ignition, AccAxisX, AccAxisY, AccAxisZ, Button, Fault, RemainingFuel, InstantFuelConsumption, TotalFuel, MovingMode, Interrupt, Speed, EngineTemperature, FuelRate, BatteryTemperature, OBDIgnition, LoadPercentage, LoadingMode, FloorCapacityRatio, FloorAreaRemaining, PowerSource, ChargeType.
valueeq in gte lte betweenNumber (exact match).
recorded_ateq in gte lte betweenDate (exact match).
text_valueeq in contains starts_withString (case-insensitive).
diffeq in gte lte betweenNumber (exact match).
sourceeq in contains starts_withString (case-insensitive).

Example

POST /v1/diagnostics/query
{
  "filters": {
    "type": "InDoor",
    "device_id": {
      "in": [
        "dvc_5f8a1c2b9e",
        "dvc_9c3f21a08b"
      ]
    },
    "value": {
      "gte": 42.5
    },
    "source": {
      "contains": "OEM"
    }
  },
  "sort": "recorded_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (device_id, type) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "device_id": "dvc_5f8a1c2b9e",
      "type": "string",
      "value": 42.5,
      "recorded_at": "2026-07-15T08:30:00.000Z",
      "text_value": "string",
      "diff": "string",
      "source": "OEM",
      "device": {
        "id": "dvc_5f8a1c2b9e",
        "name": "Truck 42",
        "serial": "SN-88213047"
      }
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

LocationsGET

Historical vehicle locations / breadcrumbs (list-only, date-cursored).

locations:read Read historical vehicle locations

Add-on callers: Narrowed through the owning device (DeviceId). Records whose device has no group ids stay visible to everyone.

  • Supports from/to; default last 30 days, max 31-day span.
  • Required filter(s): device_id.
  • List-only — no GET /locations/{id} route.
GETRead

List (GET /v1/locations), query (POST /v1/locations/query) and fetch one (GET /v1/locations/{id}).

Default fields

Always returned.

KeyTypeDescription
device_idstring
located_atstring (date-time)
timezonestring, nullable
latitudenumber
longitudenumber
speed_kmhnumber
headingnumber
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
altitudestring
hdopnumber, nullableHorizontal dilution of precision of the GPS fix. Lower is more precise. null when the device didn't report it.
satellite_countinteger, nullableNumber of satellites used for the GPS fix. null when the device didn't report it.
road_speed_limit_kmhnumber
eventstring
odometer_kmnumber
battery_percentagestring
battery_voltagestring
external_adc_voltagestring
rfid_scanstring
alarm_inputstring
engine_codestring
errors_descriptionarray of string
source_typestring
indoor_positionobject, nullablePosition on the indoor map ({x, y, map_id}), forwarded from the stored Indoor sub-document. null when not applicable.
passenger_countnumber
channelsstring
event_actionstring
Relationships (?include=)

Expand with ?include=x,y.

NameExpands toNotes
deviceDevicesDevices object (null if none)
Filters

Filter via POST /v1/locations/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
device_ideq in contains starts_withString (exact match). Required.
located_ateq in gte lte betweenDate (exact match).
latitudeeq in gte lte betweenNumber (exact match).
longitudeeq in gte lte betweenNumber (exact match).
speed_kmheq in gte lte betweenNumber (exact match).
headingeq in gte lte betweenNumber (exact match).
altitudeeq in gte lte betweenNumber (exact match).
hdopeq in gte lte betweenNumber (exact match).
satellite_counteq in gte lte betweenNumber (exact match).
road_speed_limit_kmheq in gte lte betweenNumber (exact match).
eventeq in contains starts_withString (case-insensitive).
battery_percentageeq in gte lte betweenNumber (exact match).
battery_voltageeq in gte lte betweenNumber (exact match).
external_adc_voltageeq in gte lte betweenNumber (exact match).
rfid_scaneq in contains starts_withString (case-insensitive).
alarm_inputeq in contains starts_withString (case-insensitive).
engine_codeeq in contains starts_withString (case-insensitive).
source_typeeq in gte lte betweenNumber (exact match).
passenger_counteq in gte lte betweenNumber (exact match).
channelseq in contains starts_withString (case-insensitive).
event_actioneq in contains starts_withString (case-insensitive).

Example

POST /v1/locations/query
{
  "filters": {
    "device_id": {
      "in": [
        "dvc_5f8a1c2b9e",
        "dvc_9c3f21a08b"
      ]
    },
    "located_at": {
      "gte": "2026-07-15T08:30:00.000Z"
    },
    "event": {
      "contains": "Event"
    }
  },
  "sort": "located_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (device_id) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "device_id": "dvc_5f8a1c2b9e",
      "located_at": "2026-07-15T08:30:00.000Z",
      "timezone": "string",
      "latitude": 43.6532,
      "longitude": -79.3832,
      "speed_kmh": 64.2,
      "heading": 180,
      "altitude": "string",
      "hdop": 42.5,
      "satellite_count": 3,
      "road_speed_limit_kmh": 100,
      "event": "string",
      "odometer_km": 104532.7,
      "battery_percentage": "string",
      "battery_voltage": "string",
      "external_adc_voltage": "string",
      "rfid_scan": "string",
      "alarm_input": "string",
      "engine_code": "string",
      "errors_description": [
        "string"
      ],
      "source_type": "string",
      "indoor_position": {},
      "passenger_count": 42.5,
      "channels": "string",
      "event_action": "string",
      "device": {
        "id": "dvc_5f8a1c2b9e",
        "name": "Truck 42",
        "serial": "SN-88213047"
      }
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

FormsGETDELETE

Company form definitions (layout, DVIR/safety config, reusability); notification routing details are never exposed.

forms:read forms:write Read forms, submissions and schedules

Add-on callers: Narrowed to the user's viewing groups via groupsIds. Records with no group ids stay visible to everyone.

GETRead

List (GET /v1/forms), query (POST /v1/forms/query) and fetch one (GET /v1/forms/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
namestring
descriptionstring
form_categorystring
statusstring
createdstring
created_bystring
estimate_time_in_minutesstring
is_reusableboolean
group_idsarray of string
device_idsarray of string
driver_idsarray of string
tagsarray of string
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
layoutstring
mobile_layoutstring
dvir_configstring
safety_configstring
custom_field_configstring
company_idstring
tag_idstring
form_condition_groupsarray of objectShow/hide conditional-logic groups keyed by fieldId, forwarded as-is.
form_notificationarray of objectSubmit-notification routing (EventType, CustomEmails, CustomPhone), forwarded as-is.
is_send_notificationboolean
send_for_approvalboolean
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/forms/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

No field filters. Use the list controls below.

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (form_category, status, driver_id, group_id, device_id) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "id_5f8a1c2b9e",
      "name": "Truck 42",
      "description": "Sample description.",
      "form_category": "string",
      "status": "Active",
      "created": "string",
      "created_by": "jdoe",
      "estimate_time_in_minutes": "string",
      "is_reusable": true,
      "group_ids": [
        "grp_1a2b3c4d5e"
      ],
      "device_ids": [
        "string"
      ],
      "driver_ids": [
        "string"
      ],
      "tags": [
        "priority"
      ],
      "layout": "string",
      "mobile_layout": "string",
      "dvir_config": "string",
      "safety_config": "string",
      "custom_field_config": "string",
      "company_id": "acme",
      "tag_id": "tag_9c3f21a08b",
      "form_condition_groups": [
        {}
      ],
      "form_notification": [
        {}
      ],
      "is_send_notification": true,
      "send_for_approval": true
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}
DELETEWrite

forms:write Requires the write scope. All request/response bodies use the standard { data, meta } envelope.

Delete — DELETE /v1/forms/{id}

Removes the record. Returns the deleted record's id.

Open in API Reference → · Back to top

Form submissionsGET

Submitted forms (dispatch tasks carrying a completed form), list-only and date-cursored; raw layout is sanitized into answers.

forms:read Read forms, submissions and schedules

Add-on callers: Narrowed to the user's viewing groups via groupsIds. Records with no group ids stay visible to everyone.

  • Supports from/to; default last 30 days, max 31-day span.
  • List-only — no GET /form-submissions/{id} route.
GETRead

List (GET /v1/form-submissions), query (POST /v1/form-submissions/query) and fetch one (GET /v1/form-submissions/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
form_idstring
namestring
form_categorystring
assigned_driver_idstring
statusstring
createdstring
created_bystring
submittedstring
submitted_bystring
device_idstring
submitted_locationstring, nullable
jobstring
notestring
form_descriptionstring
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
answersarray of object
dispatch_locationstring
updatedstring
updated_bystring
rejectedstring
rejected_bystring
rejected_notestring
approved_onstring
approved_bystring
needs_supervisor_approvalstring
dvir_configstring
company_idstring
group_idsarray of string
device_idsarray of string
driver_idsarray of string
tagsarray of string
tag_idstring
mobile_layoutstring
estimate_time_in_minutesnumber, nullable
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/form-submissions/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

No field filters. Use the list controls below.

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (driver_id, status, form_id, device_id, form_category) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "id_5f8a1c2b9e",
      "form_id": "for_9c3f21a08b",
      "name": "Truck 42",
      "form_category": "string",
      "assigned_driver_id": "drv_7a1e4c8f02",
      "status": "Active",
      "created": "string",
      "created_by": "jdoe",
      "submitted": "string",
      "submitted_by": "string",
      "device_id": "dvc_5f8a1c2b9e",
      "submitted_location": "string",
      "job": "string",
      "note": "string",
      "form_description": "string",
      "answers": [
        {
          "label": "string",
          "name": "Truck 42",
          "value": {},
          "type": "string",
          "options": [
            {}
          ],
          "files": [
            "string"
          ],
          "location": {
            "lat": 42.5,
            "lng": 42.5
          },
          "unit_field_detail": {
            "unit": "string",
            "value": {}
          }
        }
      ],
      "dispatch_location": "string",
      "updated": "string",
      "updated_by": "string",
      "rejected": "string",
      "rejected_by": "string",
      "rejected_note": "string",
      "approved_on": "string",
      "approved_by": "string",
      "needs_supervisor_approval": "string",
      "dvir_config": "string",
      "company_id": "acme",
      "group_ids": [
        "grp_1a2b3c4d5e"
      ],
      "device_ids": [
        "string"
      ],
      "driver_ids": [
        "string"
      ],
      "tags": [
        "priority"
      ],
      "tag_id": "tag_9c3f21a08b",
      "mobile_layout": "string",
      "estimate_time_in_minutes": 42.5
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

Form schedulesGET

Scheduled form dispatches — one row per scheduled execution of a form on a device/driver.

forms:read Read forms, submissions and schedules

Add-on callers: Not group-scoped — No group field on ScheduledFormDispatches.

  • Supports from/to (optional, uncapped) — no default window; these rows are long-lived state, not events.
GETRead

List (GET /v1/form-schedules), query (POST /v1/form-schedules/query) and fetch one (GET /v1/form-schedules/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
statusstring
recurrencestring
next_run_atstring (date-time)
last_run_atstring (date-time)
created_bystring
created_atstring (date-time)
updated_atstring (date-time)
last_dispatch_task_idsarray of string
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

None.

Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/form-schedules/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

No field filters. Use the list controls below.

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (status) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "id_5f8a1c2b9e",
      "status": "Active",
      "recurrence": "string",
      "next_run_at": "2026-07-15T08:30:00.000Z",
      "last_run_at": "2026-07-15T08:30:00.000Z",
      "created_by": "jdoe",
      "created_at": "2026-07-15T08:30:00.000Z",
      "updated_at": "2026-07-15T08:30:00.000Z",
      "last_dispatch_task_ids": [
        "string"
      ]
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

ProductsGETPOSTPATCHDELETE

Marketplace/dispatch products (pricing, stock, zone/device association).

products:read products:write Read products

Add-on callers: Not group-scoped — Parts catalog; no group dimension.

GETRead

List (GET /v1/products), query (POST /v1/products/query) and fetch one (GET /v1/products/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
namestring
descriptionstring
pricenumber
unique_idstring
titlestring
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
image_urlstring
zone_idstring
typestring
quantity_in_handnumber
tagsarray of string
device_idsarray of string
is_archivedboolean
is_marketplace_productboolean
created_atstring (date-time)
company_idstring
order_lead_timeobject, nullableOrder lead time before dispatch ({ Days, Hours, Minutes }), forwarded as-is.
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/products/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
nameeq in contains starts_withString (case-insensitive). Discover valid values via GET /v1/products.
priceeq in gte lte betweenNumber (exact match).
unique_ideq in contains starts_withString (exact match).
zone_ideq in contains starts_withString (exact match).
quantity_in_handeq in gte lte betweenNumber (exact match).
tagseq inArray of string (exact match).
device_idseq inArray of string (exact match).
is_archivedeqBoolean (exact match).
is_marketplace_producteqBoolean (exact match).
created_ateq in gte lte betweenDate (exact match).
company_ideq in contains starts_withString (exact match).

Example

POST /v1/products/query
{
  "filters": {
    "id": {
      "in": [
        "id_5f8a1c2b9e",
        "id_9c3f21a08b"
      ]
    },
    "price": {
      "gte": 42.5
    },
    "name": {
      "contains": "Truck"
    }
  },
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (name, zone_id) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "id_5f8a1c2b9e",
      "name": "Truck 42",
      "description": "Sample description.",
      "price": 42.5,
      "unique_id": "uni_9c3f21a08b",
      "title": "Check engine light",
      "image_url": "string",
      "zone_id": "zn_3c9d2a1b55",
      "type": "string",
      "quantity_in_hand": 42.5,
      "tags": [
        "priority"
      ],
      "device_ids": [
        "string"
      ],
      "is_archived": true,
      "is_marketplace_product": true,
      "created_at": "2026-07-15T08:30:00.000Z",
      "company_id": "acme",
      "order_lead_time": {}
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}
POST PATCH DELETEWrite

products:write Requires the write scope. All request/response bodies use the standard { data, meta } envelope.

Create — POST /v1/products

Required: none — send at least one writable field. Full request body — every writable field (send only what you need; the required fields must be present):

{
  "name": "string",
  "description": "string",
  "price": 0,
  "unique_id": "string",
  "title": "string",
  "image_url": "string",
  "zone_id": "string",
  "type": "string",
  "quantity_in_hand": 0,
  "tags": [
    "string"
  ],
  "device_ids": [
    "string"
  ],
  "is_archived": true,
  "is_marketplace_product": true,
  "order_lead_time": {
    "Days": 1,
    "Hours": 2,
    "Minutes": 0
  }
}
Response
{
  "data": {
    "id": "id_5f8a1c2b9e",
    "name": "Truck 42",
    "description": "Sample description.",
    "price": 42.5,
    "unique_id": "uni_9c3f21a08b",
    "title": "Check engine light",
    "image_url": "string",
    "zone_id": "zn_3c9d2a1b55",
    "type": "string",
    "quantity_in_hand": 42.5,
    "tags": [
      "priority"
    ],
    "device_ids": [
      "string"
    ],
    "is_archived": true,
    "is_marketplace_product": true,
    "created_at": "2026-07-15T08:30:00.000Z",
    "company_id": "acme",
    "order_lead_time": {}
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Update — PATCH /v1/products/{id}

Partial update: send only the fields you want to change (the same writable fields as create, minus create-only ones). Returns the updated record in the same envelope as above.

Delete — DELETE /v1/products/{id}

Removes the record. Returns the deleted record's id.

Open in API Reference → · Back to top

JobsGETPOSTPATCHDELETE

Dispatch jobs (work orders) with stops, assignment and status. Update is metadata-only — stops/device/user/assignment-type are create-only and frozen after creation to avoid triggering dispatch-service ETA recompute, reassignment, or Order-sync.

jobs:read jobs:write Read dispatch jobs

Add-on callers: Narrowed through the owning device (DeviceId). Records whose device has no group ids stay visible to everyone.

  • Supports from/to; default last 30 days, max 31-day span.
GETRead

List (GET /v1/jobs), query (POST /v1/jobs/query) and fetch one (GET /v1/jobs/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
numbernumber
namestringJob name. Required on create.
referencestring
statusstring
device_idstring
user_idstring
assignment_typestring (VEHICLE | DRIVER)How the job is assigned. Optional (defaults to VEHICLE). Assignment is optional overall — the three shapes are: set device_id for a vehicle-assigned job, user_id for a driver-assigned job, or omit both to create an Unassigned job.
due_datestring (date-time)When the job is due. Required on create and must not be in the past (ISO-8601).
created_atstring (date-time)
created_bystring
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
modified_atstring (date-time)
modified_bystring
estimated_start_datestring (date-time)
scheduled_datestring (date-time)
completed_datestring (date-time)
notesarray of objectJob notes, forwarded as-is (PascalCase sub-keys, matching the stored/downstream shape and the read response) to the dispatch service.
is_pre_bookedboolean
customobjectCustom key/value data for app integrations. Values may be string or number.
default_form_idstring
stopsarray of objectJob stops, forwarded as-is (PascalCase sub-keys, matching the stored/downstream shape and the read response) to the dispatch service. Required on create: at least one stop, and each stop must have numeric Latitude and Longitude (a non-zero position). Eta/Actual/WorkOrders are read-only.
company_idstring
recurring_reference_idstring
recurring_display_textstring
job_sourcestring
bus_journey_idstring
bus_route_idstring
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/jobs/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
numbereq in gte lte betweenNumber (exact match).
nameeq in contains starts_withString (case-insensitive). Discover valid values via GET /v1/jobs.
referenceeq in contains starts_withString (case-insensitive).
statuseq in contains starts_withString (case-insensitive). Values: Unassigned, Assigned, Dispatched, En_route_stop, Arrived_stop, Completed_stop, Completed, Cancelled, Rejected.
device_ideq in contains starts_withString (exact match).
user_ideq in contains starts_withString (exact match).
assignment_typeeq in contains starts_withString (case-insensitive). Values: VEHICLE, DRIVER.
due_dateeq in gte lte betweenDate (exact match).
created_ateq in gte lte betweenDate (exact match).
created_byeq in contains starts_withString (case-insensitive).
modified_ateq in gte lte betweenDate (exact match).
modified_byeq in contains starts_withString (case-insensitive).
estimated_start_dateeq in gte lte betweenDate (exact match).
scheduled_dateeq in gte lte betweenDate (exact match).
completed_dateeq in gte lte betweenDate (exact match).
is_pre_bookedeqBoolean (exact match).
default_form_ideq in contains starts_withString (exact match).

Example

POST /v1/jobs/query
{
  "filters": {
    "status": "Unassigned",
    "id": {
      "in": [
        "id_5f8a1c2b9e",
        "id_9c3f21a08b"
      ]
    },
    "number": {
      "gte": 42.5
    },
    "name": {
      "contains": "Truck"
    }
  },
  "sort": "created_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (device_id, user_id, status, assignment_type, reference) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "id_5f8a1c2b9e",
      "number": 42.5,
      "name": "Truck 42",
      "reference": "string",
      "status": "Active",
      "device_id": "dvc_5f8a1c2b9e",
      "user_id": "use_9c3f21a08b",
      "assignment_type": "VEHICLE",
      "due_date": "2026-07-15T08:30:00.000Z",
      "created_at": "2026-07-15T08:30:00.000Z",
      "created_by": "jdoe",
      "modified_at": "2026-07-15T08:30:00.000Z",
      "modified_by": "string",
      "estimated_start_date": "2026-07-15T08:30:00.000Z",
      "scheduled_date": "2026-07-15T08:30:00.000Z",
      "completed_date": "2026-07-15T08:30:00.000Z",
      "notes": [
        {
          "Text": "string",
          "Username": "string",
          "Files": [
            "string"
          ],
          "Date": "2026-07-15T08:30:00.000Z"
        }
      ],
      "is_pre_booked": true,
      "custom": {
        "sample": {}
      },
      "default_form_id": "def_9c3f21a08b",
      "stops": [
        {
          "Id": "string",
          "Name": "string",
          "Address": "string",
          "CustomerId": "string",
          "Latitude": 42.5,
          "Longitude": 42.5,
          "Note": "string",
          "IsStartLocation": true,
          "Eta": {
            "StopDuration": 42.5,
            "Duration": 42.5,
            "Distance": 42.5,
            "ArrivalDate": "2026-07-15T08:30:00.000Z",
            "DepartureDate": "2026-07-15T08:30:00.000Z"
          },
          "Actual": {
            "StopDuration": 42.5,
            "Duration": 42.5,
            "Distance": 42.5,
            "ArrivalDate": "2026-07-15T08:30:00.000Z",
            "DepartureDate": "2026-07-15T08:30:00.000Z"
          },
          "WorkOrders": [
            {}
          ]
        }
      ],
      "company_id": "acme",
      "recurring_reference_id": "rec_9c3f21a08b",
      "recurring_display_text": "string",
      "job_source": "string",
      "bus_journey_id": "bus_9c3f21a08b",
      "bus_route_id": "bus_9c3f21a08b"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}
POST PATCH DELETEWrite

jobs:write Requires the write scope. All request/response bodies use the standard { data, meta } envelope.

Create — POST /v1/jobs

Required: name, due_date, stops. Full request body — every writable field (send only what you need; the required fields must be present):

{
  "name": "string",
  "reference": "string",
  "device_id": "string",
  "user_id": "string",
  "assignment_type": "VEHICLE",
  "due_date": "2026-01-01T00:00:00Z",
  "estimated_start_date": "2026-01-01T00:00:00Z",
  "notes": [
    {
      "Text": "string",
      "Username": "string",
      "Files": [
        "string"
      ],
      "Date": "2026-01-01T00:00:00Z"
    }
  ],
  "is_pre_booked": true,
  "custom": {},
  "default_form_id": "string",
  "stops": [
    {
      "Id": "string",
      "Name": "string",
      "Address": "string",
      "CustomerId": "string",
      "Latitude": 43.6532,
      "Longitude": -79.3832,
      "Note": "string",
      "IsStartLocation": true
    }
  ]
}
Response
{
  "data": {
    "id": "id_5f8a1c2b9e",
    "number": 42.5,
    "name": "Truck 42",
    "reference": "string",
    "status": "Active",
    "device_id": "dvc_5f8a1c2b9e",
    "user_id": "use_9c3f21a08b",
    "assignment_type": "VEHICLE",
    "due_date": "2026-07-15T08:30:00.000Z",
    "created_at": "2026-07-15T08:30:00.000Z",
    "created_by": "jdoe",
    "modified_at": "2026-07-15T08:30:00.000Z",
    "modified_by": "string",
    "estimated_start_date": "2026-07-15T08:30:00.000Z",
    "scheduled_date": "2026-07-15T08:30:00.000Z",
    "completed_date": "2026-07-15T08:30:00.000Z",
    "notes": [
      {
        "Text": "string",
        "Username": "string",
        "Files": [
          "string"
        ],
        "Date": "2026-07-15T08:30:00.000Z"
      }
    ],
    "is_pre_booked": true,
    "custom": {
      "sample": {}
    },
    "default_form_id": "def_9c3f21a08b",
    "stops": [
      {
        "Id": "string",
        "Name": "string",
        "Address": "string",
        "CustomerId": "string",
        "Latitude": 42.5,
        "Longitude": 42.5,
        "Note": "string",
        "IsStartLocation": true,
        "Eta": {
          "StopDuration": 42.5,
          "Duration": 42.5,
          "Distance": 42.5,
          "ArrivalDate": "2026-07-15T08:30:00.000Z",
          "DepartureDate": "2026-07-15T08:30:00.000Z"
        },
        "Actual": {
          "StopDuration": 42.5,
          "Duration": 42.5,
          "Distance": 42.5,
          "ArrivalDate": "2026-07-15T08:30:00.000Z",
          "DepartureDate": "2026-07-15T08:30:00.000Z"
        },
        "WorkOrders": [
          {}
        ]
      }
    ],
    "company_id": "acme",
    "recurring_reference_id": "rec_9c3f21a08b",
    "recurring_display_text": "string",
    "job_source": "string",
    "bus_journey_id": "bus_9c3f21a08b",
    "bus_route_id": "bus_9c3f21a08b"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Update — PATCH /v1/jobs/{id}

Partial update: send only the fields you want to change (the same writable fields as create, minus create-only ones). Returns the updated record in the same envelope as above.

Delete — DELETE /v1/jobs/{id}

Removes the record. Returns the deleted record's id.

Open in API Reference → · Back to top

Tracker typesGET

Global device tracker-type catalog (device category, docs and support links; shared reference data, no tenant scoping).

devices:read Read devices and their live status

Add-on callers: Not group-scoped — Reference data; no group dimension.

GETRead

List (GET /v1/tracker-types), query (POST /v1/tracker-types/query) and fetch one (GET /v1/tracker-types/{id}).

Default fields

Always returned.

KeyTypeDescription
namestring
display_namestring
device_categorystring
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
descriptionstring
image_urlstring
portal_linkstring
setup_linkstring
support_emailstring
support_phonestring
trax_pricingnumber
geotab_custom_pricingnumber
trainingnumber
sla_documentation_linkstring
accessories_linkstring
installation_document_linkstring
partner_installation_video_linkstring
troubleshooting_document_linkstring
partner_video_linkstring
data_plan_mbnumber
featuresarray of objectTracker-type feature list, forwarded as-is per stored item shape.
crm_productobject, nullableCRM product/SKU mapping, forwarded as-is.
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/tracker-types/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
nameeq in contains starts_withString (exact match). Discover valid values via GET /v1/tracker-types.
display_nameeq in contains starts_withString (case-insensitive).
device_categoryeq in contains starts_withString (case-insensitive).
descriptioneq in contains starts_withString (case-insensitive).
support_emaileq in contains starts_withString (case-insensitive).
support_phoneeq in contains starts_withString (case-insensitive).

Example

POST /v1/tracker-types/query
{
  "filters": {
    "name": {
      "in": [
        "Truck 42",
        "Truck 42 2"
      ]
    },
    "description": {
      "contains": "Sample"
    }
  },
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (name) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "name": "Truck 42",
      "display_name": "string",
      "device_category": "string",
      "description": "Sample description.",
      "image_url": "string",
      "portal_link": "string",
      "setup_link": "string",
      "support_email": "string",
      "support_phone": "string",
      "trax_pricing": 42.5,
      "geotab_custom_pricing": 42.5,
      "training": 42.5,
      "sla_documentation_link": "string",
      "accessories_link": "string",
      "installation_document_link": "string",
      "partner_installation_video_link": "string",
      "troubleshooting_document_link": "string",
      "partner_video_link": "string",
      "data_plan_mb": 42.5,
      "features": [
        {}
      ],
      "crm_product": {}
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

Custom mapsGET

Custom (Indoor/Web) map overlays for a company's locations, tenant-scoped.

maps:read

Add-on callers: Not group-scoped — Company-wide map overlays; no group dimension.

GETRead

List (GET /v1/custom-maps), query (POST /v1/custom-maps/query) and fetch one (GET /v1/custom-maps/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
map_namestring
namestring
typestring
web_urlstring, nullable
indoor_image_urlstring, nullable
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
orderstring
company_idstring
location_namestring
location_latnumber, nullable
location_lngnumber, nullable
indoor_rotationnumber, nullable
indoor_devicesarray of object
indoor_beaconsarray of object
indoor_scalenumber, nullable
indoor_image_widthnumber, nullable
indoor_image_heightnumber, nullable
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/custom-maps/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
map_nameeq in contains starts_withString (case-insensitive).
nameeq in contains starts_withString (case-insensitive). Discover valid values via GET /v1/custom-maps.
typeeq in contains starts_withString (case-insensitive). Values: Indoor, Web.
ordereq in gte lte betweenNumber (exact match).
company_ideq in contains starts_withString (exact match).
location_nameeq in contains starts_withString (case-insensitive).

Example

POST /v1/custom-maps/query
{
  "filters": {
    "type": "Indoor",
    "id": {
      "in": [
        "id_5f8a1c2b9e",
        "id_9c3f21a08b"
      ]
    },
    "order": {
      "gte": 42.5
    },
    "name": {
      "contains": "Truck"
    }
  },
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (id, type) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "id_5f8a1c2b9e",
      "map_name": "string",
      "name": "Truck 42",
      "type": "string",
      "web_url": "string",
      "indoor_image_url": "string",
      "order": "string",
      "company_id": "acme",
      "location_name": "string",
      "location_lat": 42.5,
      "location_lng": 42.5,
      "indoor_rotation": 42.5,
      "indoor_devices": [
        {
          "id": "id_5f8a1c2b9e",
          "left": 42.5,
          "top": 42.5,
          "device_placed": true
        }
      ],
      "indoor_beacons": [
        {
          "id": "id_5f8a1c2b9e",
          "left": 42.5,
          "top": 42.5,
          "device_placed": true
        }
      ],
      "indoor_scale": 42.5,
      "indoor_image_width": 42.5,
      "indoor_image_height": 42.5
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

CommentsGET

Comments attached to a parent entity (polymorphic ParentId, commonly a safety event), tenant-scoped, list-only, date-cursored.

comments:read

Add-on callers: Not group-scoped — Polymorphic ParentId with no ParentType to join on. requiredFilters: parent_id means a caller must already hold a parent id, and parent listings are themselves narrowed.

  • Supports from/to (optional, uncapped) — no default window; these rows are long-lived state, not events.
  • Required filter(s): parent_id.
  • List-only — no GET /comments/{id} route.
GETRead

List (GET /v1/comments), query (POST /v1/comments/query) and fetch one (GET /v1/comments/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
parent_idstring
textstring
created_atstring (date-time)
user_idstring
user_full_namestring
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
updated_atstring (date-time)
is_visible_to_driverboolean
company_idstring
attachmentsarray of objectAttached files ({Url, Name}), forwarded as-is.
linkobject, nullableLinked resource ({Url, Title}), forwarded as-is. null when not set.
is_editableboolean
additional_notesarray of objectAdditional key/value notes ({Key, Value}), forwarded as-is.
updated_by_user_idstring
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/comments/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
parent_ideq in contains starts_withString (exact match). Required.
texteq in contains starts_withString (case-insensitive).
created_ateq in gte lte betweenDate (exact match).
user_ideq in contains starts_withString (exact match).
user_full_nameeq in contains starts_withString (case-insensitive).
updated_ateq in gte lte betweenDate (exact match).
is_visible_to_drivereqBoolean (exact match).

Example

POST /v1/comments/query
{
  "filters": {
    "parent_id": {
      "in": [
        "par_9c3f21a08b",
        "par_9c3f21a08b"
      ]
    },
    "created_at": {
      "gte": "2026-07-15T08:30:00.000Z"
    },
    "user_id": {
      "contains": "use_9c3f21a08b"
    }
  },
  "sort": "created_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (parent_id) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "id_5f8a1c2b9e",
      "parent_id": "par_9c3f21a08b",
      "text": "string",
      "created_at": "2026-07-15T08:30:00.000Z",
      "user_id": "use_9c3f21a08b",
      "user_full_name": "string",
      "updated_at": "2026-07-15T08:30:00.000Z",
      "is_visible_to_driver": true,
      "company_id": "acme",
      "attachments": [
        {}
      ],
      "link": {},
      "is_editable": true,
      "additional_notes": [
        {}
      ],
      "updated_by_user_id": "upd_9c3f21a08b"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

UsersGETPOSTPATCHDELETE

All users (from the users collection, not just drivers; filter with is_driver to narrow); credentials and security state are never exposed.

users:read users:write

Add-on callers: Narrowed to the user's viewing groups via ViewingGroups. Records with no group ids stay visible to everyone.

GETRead

List (GET /v1/users), query (POST /v1/users/query) and fetch one (GET /v1/users/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
usernamestringLogin username. Required on create; create-only. A password is auto-generated when omitted.
first_namestring
last_namestring
full_namestring, nullable
is_driverboolean
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
group_idsarray of stringGroup ids the user belongs to. Required on create — at least one group must be supplied.
emailstring
phonestring
unitsstring
languagestring
user_typestringUser role. Optional — defaults to Driver; an unrecognised value is rejected on create with "Invalid UserType".
employee_idstring
created_atstring (date-time)
last_loginstring (date-time)
company_idstring
license_numberstring
license_statestring
license_countrystring
working_hoursobjectPer-day working-hours schedule, forwarded as-is (e.g. { Mon: { active, hours: { from, to } }, … }).
time_zonestring
photo_urlstring
telegram_chat_idstring
region_idsarray of string
business_group_idsarray of string
people_group_idsarray of string
can_assign_job_itselfboolean
default_viewstring
fetch_location_from_mobileboolean
feature_previewboolean
supervisor_idsarray of string
driver_app_dataobject, nullableDriver app data — check-in/out, breaks, work-time tracking, forwarded as-is.
map_providerstring
custom_fieldsobjectTenant-defined custom field values, keyed by field name, forwarded as-is.
driver_identificationstring
verification_phone_numberstring
show_self_databoolean
commentsstring
live_notification_settingsobject, nullableLive-notification preferences, forwarded as-is.
switchboard_idstring
hos_enabledboolean
hos_exemptedboolean
rule_setstring
us_hos_cyclestring
home_terminal_namestring
home_terminal_addressobject, nullableHome-terminal location ({ Location: { latitude, longitude }, LocationName }), forwarded as-is.
exemption_annotationstring
yard_move_allowedboolean
personal_conveyance_allowedboolean
pinned_add_in_idsarray of string
Relationships (?include=)

Expand with ?include=x,y.

NameExpands toNotes
groupsArray of GroupsArray of Groups (empty if none)
Filters

Filter via POST /v1/users/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
ideq in contains starts_withString (exact match).
usernameeq in contains starts_withString (case-insensitive).
first_nameeq in contains starts_withString (case-insensitive).
last_nameeq in contains starts_withString (case-insensitive).
is_drivereqBoolean (exact match).
group_idseq inArray of string (exact match).
emaileq in contains starts_withString (case-insensitive).
phoneeq in contains starts_withString (case-insensitive).
unitseq in contains starts_withString (case-insensitive).
languageeq in contains starts_withString (case-insensitive).
user_typeeq in contains starts_withString (case-insensitive). Values: Driver, End Customer, EndUser, General User, Passenger, Technician.
employee_ideq in contains starts_withString (case-insensitive).
created_ateq in gte lte betweenDate (exact match).
last_logineq in gte lte betweenDate (exact match).
company_ideq in contains starts_withString (exact match).
license_numbereq in contains starts_withString (case-insensitive).
license_stateeq in contains starts_withString (case-insensitive).
license_countryeq in contains starts_withString (case-insensitive).

Example

POST /v1/users/query
{
  "filters": {
    "user_type": "Driver",
    "id": {
      "in": [
        "id_5f8a1c2b9e",
        "id_9c3f21a08b"
      ]
    },
    "created_at": {
      "gte": "2026-07-15T08:30:00.000Z"
    },
    "username": {
      "contains": "jdoe"
    }
  },
  "sort": "created_at:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (username, is_driver, group_id) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "id_5f8a1c2b9e",
      "username": "jdoe",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "string",
      "is_driver": true,
      "group_ids": [
        "grp_1a2b3c4d5e"
      ],
      "email": "jdoe@example.com",
      "phone": "+1-555-0142",
      "units": "metric",
      "language": "en",
      "user_type": "string",
      "employee_id": "emp_9c3f21a08b",
      "created_at": "2026-07-15T08:30:00.000Z",
      "last_login": "2026-07-15T08:30:00.000Z",
      "company_id": "acme",
      "license_number": "D1234-56789",
      "license_state": "ON",
      "license_country": "CA",
      "working_hours": {},
      "time_zone": "string",
      "photo_url": "string",
      "telegram_chat_id": "tel_9c3f21a08b",
      "region_ids": [
        "string"
      ],
      "business_group_ids": [
        "string"
      ],
      "people_group_ids": [
        "string"
      ],
      "can_assign_job_itself": true,
      "default_view": "string",
      "fetch_location_from_mobile": true,
      "feature_preview": true,
      "supervisor_ids": [
        "string"
      ],
      "driver_app_data": {},
      "map_provider": "string",
      "custom_fields": {},
      "driver_identification": "string",
      "verification_phone_number": "string",
      "show_self_data": true,
      "comments": "string",
      "live_notification_settings": {},
      "switchboard_id": "swi_9c3f21a08b",
      "hos_enabled": true,
      "hos_exempted": true,
      "rule_set": "string",
      "us_hos_cycle": "string",
      "home_terminal_name": "string",
      "home_terminal_address": {},
      "exemption_annotation": "string",
      "yard_move_allowed": true,
      "personal_conveyance_allowed": true,
      "pinned_add_in_ids": [
        "string"
      ],
      "groups": [
        {
          "id": "grp_5f8a1c2b9e",
          "name": "Truck 42"
        }
      ]
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}
POST PATCH DELETEWrite

users:write Requires the write scope. All request/response bodies use the standard { data, meta } envelope.

Create — POST /v1/users

Required: username, group_ids. Full request body — every writable field (send only what you need; the required fields must be present):

{
  "username": "string",
  "first_name": "string",
  "last_name": "string",
  "group_ids": [
    "string"
  ],
  "email": "string",
  "phone": "string",
  "units": "string",
  "language": "string",
  "user_type": "string",
  "employee_id": "string",
  "license_number": "string",
  "license_state": "string",
  "license_country": "string",
  "working_hours": {
    "Mon": {
      "active": true,
      "hours": {
        "from": "09:00",
        "to": "17:00"
      }
    }
  },
  "password": "string",
  "time_zone": "string",
  "photo_url": "string",
  "region_ids": [
    "string"
  ],
  "business_group_ids": [
    "string"
  ],
  "people_group_ids": [
    "string"
  ],
  "can_assign_job_itself": true,
  "default_view": "string",
  "fetch_location_from_mobile": true,
  "feature_preview": true,
  "supervisor_ids": [
    "string"
  ],
  "driver_app_data": {},
  "map_provider": "string",
  "custom_fields": {},
  "driver_identification": "string",
  "show_self_data": true,
  "comments": "string",
  "live_notification_settings": {},
  "hos_enabled": true,
  "hos_exempted": true,
  "rule_set": "string",
  "us_hos_cycle": "string",
  "home_terminal_name": "string",
  "home_terminal_address": {
    "Location": {
      "latitude": 43.6532,
      "longitude": -79.3832
    },
    "LocationName": "Main Depot"
  },
  "exemption_annotation": "string",
  "yard_move_allowed": true,
  "personal_conveyance_allowed": true,
  "pinned_add_in_ids": [
    "string"
  ]
}
Response
{
  "data": {
    "id": "id_5f8a1c2b9e",
    "username": "jdoe",
    "first_name": "Jane",
    "last_name": "Doe",
    "full_name": "string",
    "is_driver": true,
    "group_ids": [
      "grp_1a2b3c4d5e"
    ],
    "email": "jdoe@example.com",
    "phone": "+1-555-0142",
    "units": "metric",
    "language": "en",
    "user_type": "string",
    "employee_id": "emp_9c3f21a08b",
    "created_at": "2026-07-15T08:30:00.000Z",
    "last_login": "2026-07-15T08:30:00.000Z",
    "company_id": "acme",
    "license_number": "D1234-56789",
    "license_state": "ON",
    "license_country": "CA",
    "working_hours": {},
    "time_zone": "string",
    "photo_url": "string",
    "telegram_chat_id": "tel_9c3f21a08b",
    "region_ids": [
      "string"
    ],
    "business_group_ids": [
      "string"
    ],
    "people_group_ids": [
      "string"
    ],
    "can_assign_job_itself": true,
    "default_view": "string",
    "fetch_location_from_mobile": true,
    "feature_preview": true,
    "supervisor_ids": [
      "string"
    ],
    "driver_app_data": {},
    "map_provider": "string",
    "custom_fields": {},
    "driver_identification": "string",
    "verification_phone_number": "string",
    "show_self_data": true,
    "comments": "string",
    "live_notification_settings": {},
    "switchboard_id": "swi_9c3f21a08b",
    "hos_enabled": true,
    "hos_exempted": true,
    "rule_set": "string",
    "us_hos_cycle": "string",
    "home_terminal_name": "string",
    "home_terminal_address": {},
    "exemption_annotation": "string",
    "yard_move_allowed": true,
    "personal_conveyance_allowed": true,
    "pinned_add_in_ids": [
      "string"
    ]
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Update — PATCH /v1/users/{id}

Partial update: send only the fields you want to change (the same writable fields as create, minus create-only ones). Returns the updated record in the same envelope as above.

Delete — DELETE /v1/users/{id}

Removes the record. Returns the deleted record's id.

Open in API Reference → · Back to top

Coaching sessionsGET

Driver coaching deliveries (AI or manual): who was coached, when, on which safety events, and the delivery status.

coaching:read Read driver coaching sessions

Add-on callers: Narrowed through the owning device (DeviceId). Records whose device has no group ids stay visible to everyone.

  • Supports from/to; default last 30 days.
GETRead

List (GET /v1/coaching-sessions), query (POST /v1/coaching-sessions/query) and fetch one (GET /v1/coaching-sessions/{id}).

Default fields

Always returned.

KeyTypeDescription
idstring
driver_idstring
device_idstring
coaching_datestring (date-time)
methodstring
coach_idstring
statusstring
digest_typestring
exceptions_coachedstring
badgesstring
rule_idsarray of string
is_acknowledgedboolean
created_atstring (date-time)
updated_atstring (date-time)
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
coaching_notesstring
Relationships (?include=)

Expand with ?include=x,y.

None.

Filters

Filter via POST /v1/coaching-sessions/query with a JSON filters object. A bare value means equals (eq); a bare array means any-of (in); or use an explicit operator object, e.g. {"gte": 10}.

FilterOperatorsNotes
driver_ideq inString (exact match).
device_ideq inString (exact match).
coaching_dateeq in gte lte betweenDate (exact match).
methodeq inString (case-insensitive). Values: AI, MANUAL.
coach_ideq inString (exact match).
statuseq inString (case-insensitive). Values: Pending, WaitingForSafeWindow, Delivering, Completed, Cancelled, Failed.
digest_typeeq inString (case-insensitive). Values: daily, weekly, monthly.
is_acknowledgedeqBoolean (exact match).

Example

POST /v1/coaching-sessions/query
{
  "filters": {
    "method": "AI",
    "driver_id": {
      "in": [
        "drv_7a1e4c8f02",
        "drv_9c3f21a08b"
      ]
    },
    "coaching_date": {
      "gte": "2026-07-15T08:30:00.000Z"
    }
  },
  "sort": "coaching_date:desc",
  "limit": 20
}

Request controls: sort, from/to (time-series), limit, cursor, count — documented in the API Reference.

A few bare-equality query params (driver_id, device_id, status, method) are also accepted on GET for backwards-compatibility; the filters body above is the complete mechanism.

Example response
{
  "data": [
    {
      "id": "id_5f8a1c2b9e",
      "driver_id": "drv_7a1e4c8f02",
      "device_id": "dvc_5f8a1c2b9e",
      "coaching_date": "2026-07-15T08:30:00.000Z",
      "method": "string",
      "coach_id": "coa_9c3f21a08b",
      "status": "Active",
      "digest_type": "string",
      "exceptions_coached": "string",
      "badges": "string",
      "rule_ids": [
        "string"
      ],
      "is_acknowledged": true,
      "created_at": "2026-07-15T08:30:00.000Z",
      "updated_at": "2026-07-15T08:30:00.000Z",
      "coaching_notes": "string"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

Device statusGET

Live current-state sub-resource of a device — position, speed, heading, ignition.

devices:read Read devices and their live status

Default fields

Always returned.

KeyTypeDescription
device_idstring
latitudenumber
longitudenumber
speed_kmhnumber
headingnumber
is_ignition_onboolean
is_movingboolean
is_communicatingboolean
updated_atstring (date-time)
Example response
{
  "data": {
    "device_id": "dvc_5f8a1c2b9e",
    "latitude": 43.6532,
    "longitude": -79.3832,
    "speed_kmh": 64.2,
    "heading": 180,
    "is_ignition_on": true,
    "is_moving": true,
    "is_communicating": true,
    "updated_at": "2026-07-15T08:30:00.000Z"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

Open in API Reference → · Back to top

Driver summaryGET

Aggregated per-driver rollup over a date range — trips, distance, exceptions, safety score.

summaries:read Read driver and vehicle summaries

  • Aggregation over a date range; from/to as YYYY-MM-DD, default yesterday, max 31 days.
Default fields

Always returned.

KeyTypeDescription
driver_idstring
driver_namestring
driver_emailstring
periodSummaryPeriod
distancenumberDistance in kilometres.
driving_durationnumberDriving time in seconds.
idling_durationnumberIdling time in seconds.
trip_countnumber
max_speed_kmhnumber
avg_speed_kmhnumber
idling_rationumberIdling over driving + idling time, as a fraction 0–1.
safety_scorenumberSafety score 0–100; higher is safer.
risk_bandstring
p_accidentnumberModelled accident probability, 0–1.
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
avg_trip_dist_kmnumber
speeding_durationnumberSpeeding time in seconds.
speeding_event_countnumber
harsh_braking_countnumber
harsh_acceleration_countnumber
seatbelt_violationsnumber
idling_event_countnumber
exceptionsobjectMap of name → count.
after_hours_driving_durationnumberAfter-hours driving time in seconds.
after_hours_distancenumberAfter-hours distance in kilometres.
after_hours_stop_durationnumberAfter-hours stopped time in seconds.
speeding_rationumberSpeeding over driving time, as a fraction 0–1.
after_hours_rationumberAfter-hours over driving time, as a fraction 0–1.
braking_per_100kmnumberHarsh-braking events per 100 kilometres.
accel_per_100kmnumberHarsh-acceleration events per 100 kilometres.
speeding_pctnumberSame quantity as speeding_ratio, as a percentage 0–100.
idling_pctnumberSame quantity as idling_ratio, as a percentage 0–100.
after_hours_pctnumberSame quantity as after_hours_ratio, as a percentage 0–100.
Example response
{
  "data": {
    "driver_id": "drv_7a1e4c8f02",
    "driver_name": "Jane Doe",
    "driver_email": "jane.doe@example.com",
    "period": {
      "from": "2026-06-01",
      "to": "2026-06-07"
    },
    "distance": 42.5,
    "driving_duration": 42.5,
    "idling_duration": 42.5,
    "trip_count": 42.5,
    "max_speed_kmh": 96.3,
    "avg_speed_kmh": 58.1,
    "idling_ratio": 42.5,
    "safety_score": 42.5,
    "risk_band": "string",
    "p_accident": 42.5,
    "avg_trip_dist_km": 42.5,
    "speeding_duration": 42.5,
    "speeding_event_count": 42.5,
    "harsh_braking_count": 42.5,
    "harsh_acceleration_count": 42.5,
    "seatbelt_violations": 42.5,
    "idling_event_count": 42.5,
    "exceptions": {
      "speeding": 3
    },
    "after_hours_driving_duration": 42.5,
    "after_hours_distance": 42.5,
    "after_hours_stop_duration": 42.5,
    "speeding_ratio": 42.5,
    "after_hours_ratio": 42.5,
    "braking_per_100km": 42.5,
    "accel_per_100km": 42.5,
    "speeding_pct": 42.5,
    "idling_pct": 42.5,
    "after_hours_pct": 42.5
  },
  "meta": {
    "request_id": "req_abc123",
    "period": {
      "from": "2026-06-01",
      "to": "2026-06-07"
    }
  }
}

Open in API Reference → · Back to top

Vehicle summaryGET

Aggregated per-vehicle rollup over a date range — distance, durations, odometer, drivers.

summaries:read Read driver and vehicle summaries

  • Aggregation over a date range; from/to as YYYY-MM-DD, default yesterday, max 31 days.
Default fields

Always returned.

KeyTypeDescription
device_idstring
license_platestring
vinstring
periodSummaryPeriod
distancenumberDistance in kilometres.
driving_durationnumberDriving time in seconds.
idling_durationnumberIdling time in seconds.
trip_countnumber
avg_speed_kmhnumber
idling_rationumberIdling over driving + idling time, as a fraction 0–1.
odometer_kmnumber
Optional fields (?fields=)

Add these with ?fields=a,b — they ship on top of the defaults.

KeyTypeDescription
after_hours_driving_durationnumberAfter-hours driving time in seconds.
after_hours_distancenumberAfter-hours distance in kilometres.
after_hours_stop_durationnumberAfter-hours stopped time in seconds.
work_driving_durationnumberOn-schedule driving time in seconds.
work_distancenumberOn-schedule distance in kilometres.
work_stop_durationnumberOn-schedule stopped time in seconds.
daily_distance_km_ecunumber
engine_hours_totalnumber
driver_change_countnumber
drivers_on_vehiclearray of string
after_hours_rationumberAfter-hours over driving time, as a fraction 0–1.
Example response
{
  "data": {
    "device_id": "dvc_5f8a1c2b9e",
    "license_plate": "ABC-1234",
    "vin": "1FTFW1E5XKF12345",
    "period": {
      "from": "2026-06-01",
      "to": "2026-06-07"
    },
    "distance": 42.5,
    "driving_duration": 42.5,
    "idling_duration": 42.5,
    "trip_count": 42.5,
    "avg_speed_kmh": 58.1,
    "idling_ratio": 42.5,
    "odometer_km": 104532.7,
    "after_hours_driving_duration": 42.5,
    "after_hours_distance": 42.5,
    "after_hours_stop_duration": 42.5,
    "work_driving_duration": 42.5,
    "work_distance": 42.5,
    "work_stop_duration": 42.5,
    "daily_distance_km_ecu": 42.5,
    "engine_hours_total": 42.5,
    "driver_change_count": 42.5,
    "drivers_on_vehicle": [
      "drv_7a1e4c8f02"
    ],
    "after_hours_ratio": 42.5
  },
  "meta": {
    "request_id": "req_abc123",
    "period": {
      "from": "2026-06-01",
      "to": "2026-06-07"
    }
  }
}

Open in API Reference → · Back to top

IFTA summaryGET

Distance by vehicle × jurisdiction × month, aggregated from trips, for IFTA / state-mileage reporting.

ifta:read Read IFTA / state-mileage summaries

  • List endpoint (keyset pagination); supports from/to (default: current UTC month to date; max 31 days) and an optional device_id filter.
Default fields

Always returned.

KeyTypeDescription
device_idstring
jurisdictionstringUS state / CA province of the trip's start position.
countrystring
monthstringYYYY-MM (UTC).
distance_kmnumberSummed trip distance for the vehicle in that jurisdiction and month (km).
trip_countinteger
Example response
{
  "data": [
    {
      "device_id": "dvc_5f8a1c2b9e",
      "jurisdiction": "ON",
      "country": "CA",
      "month": "2026-06",
      "distance_km": 42.5,
      "trip_count": 3
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

Media (video & camera)GET

Camera/DVR actions for a device (POST, not CRUD). Each endpoint returns a DIFFERENT shape: POST /media/recordings → available recording segments (RecordingSegment[], shown below — footage windows with NO url); POST /media/live-streams and POST /media/historical-streams → stream sources (LiveSource[], with a stream url); POST /media/video-requests and POST /media/snapshot-requests → an async { task_id }; GET /media/tasks/{task_id} → a MediaTaskStatus whose result is MediaItem[] (the finished clips/snapshots, WITH url/full_url/screenshot); POST /media/wake → { success }. All delegate to trax-client-service, which owns device/tenant validation and dispatch to the camera provider.

media:read Read camera media — live/historical stream URLs, recordings, and media task status

  • Video/snapshot/wake need media:write; streams/recordings/task-status need media:read. Receiving recorded footage is a two-step flow: POST /media/recordings is an INDEX — it lists the available segments (below), which are NOT downloadable files; take a segment's date_from and either WATCH it with POST /media/historical-streams (returns a playable stream url) or DOWNLOAD a clip with POST /media/video-requests (async — poll GET /media/tasks/{task_id} until status is completed, then read result, a MediaItem[] with url/full_url/screenshot). The DVR generates media on demand, which is why the recordings list has no urls. Every shape (RecordingSegment, LiveSource, MediaItem) carries a raw field with the provider's full record verbatim, so provider-specific fields are never hidden. See the API Reference for the LiveSource/MediaItem/MediaTaskStatus schemas.
Default fields

Always returned.

KeyTypeDescription
device_idstring
channelinteger
date_fromstring (date-time)
date_tostring (date-time)
stream_typeinteger
rawobjectThe provider's full recording record verbatim; shape varies by camera provider.
Example response
{
  "data": [
    {
      "device_id": "dvc_5f8a1c2b9e",
      "channel": 3,
      "date_from": "2026-07-15T08:30:00.000Z",
      "date_to": "2026-07-15T08:30:00.000Z",
      "stream_type": 3,
      "raw": {}
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

GeocodingGET

Reverse-geocode coordinates to addresses plus the company's containing zone. POST /geocoding/addresses with { coordinates: [{ lat, lng }] }; the response array is parallel to the input coordinates.

geocoding:read Reverse-geocode coordinates to addresses and the company's containing zones

Default fields

Always returned.

KeyTypeDescription
formatted_addressstring
zoneobjectThe company zone containing the coordinate, or null if none.
Example response
{
  "data": [
    {
      "formatted_address": "string",
      "zone": {}
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": null,
    "has_more": false
  }
}

Open in API Reference → · Back to top

Text-to-SpeechGET

Send a text-to-speech audio message to StreamMax cameras. POST /tts/messages with { device_ids, text, language } — text is 150 characters or fewer, language is english or spanish. The result reports per-device success and failed (e.g. a non-StreamMax device fails individually, never reaching the provider).

tts:write Send a text-to-speech audio message to StreamMax cameras

Default fields

Always returned.

KeyTypeDescription
successarray of stringDevice ids the message was sent to.
failedarray of objectDevice ids the message could not be sent to, with an error per device (e.g. not a StreamMax device).
Example response
{
  "data": {
    "success": [
      "string"
    ],
    "failed": [
      {
        "device_id": "dvc_5f8a1c2b9e",
        "error": "string"
      }
    ]
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

Open in API Reference → · Back to top