Get Vehicle
Get detailed information about a specific vehicle.
Documentation Index
Fetch the complete documentation index at: https://docs.catenatelematics.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the vehicle.
Query Parameters
Include the raw data from the telematics provider. Useful for auditing or accessing fields not normalized by Catena
Response
Successful Response
Vehicle model for API responses
Internal fleet identifier.
Unique identifier of the record at Catena Telematics.
Immutable: The datetime the record was ingested into Catena Telematics.
The dateime the record was last modified in Catena Telematics.
Unique identifier of the connection at Catena Telematics through which this record was ingested. A connection represents a Fleet/TSP pairing.
The underlying telematics platform that provided this data (e.g., samsara, motive, hos247). Note: Some platforms like hos247 offer white-labeling, so multiple TSPs may share the same source_name — use tsp_id or tsp_slug to identify the specific ELD provider.
ada, ai_eld, air_eld, alfa_eld, alpha_eld, als, anytrek_pro, anytrek_classic, apex_eld, apollo, apollocloud, ascend, att, awaregps, azuga, bigroad, bluehorse_eld, blueinktech, bouncie, budgetgps, catena_simulator, captain_eld, carrier_lynx, club_eld, counting_trucks_eld, cyntrx, digital_eld, dragon_eld, drive_hos, driver_tech, dsg_elogs, dynamic_eld, eighteighteight_eld, eld_88, eld_books, eld_mandate, eld_mandate_prime, eroad, eva_eld, evo_eld, expressway_eld, extreme_eld, ezlogz, ez_lynk, factor_eld, firstgate, fleetcomplete, fleetcompletehub, fleethunt, fleetsharp, fleetup, fm, forwardthinking, forza_eld, geotab, gpsinsight, gpstab, gpstrackit, grand_eld, greenlight, groundhog, hcss, hos247, hutch, intellishift, ironman_eld, isaac, jjkeller, kinexaiot, knight_eld, konexial, lioneight, linxup, loop_eld, lucid_eld, luna_eld, lytx, lytxv3, mapon, matrack, maven, mdm_eld, mobilefleet, moonlight_eld, motion_eld, motive, my_drivebook, my_logs_eld, nero, netradyne, new_eld_world, nextgen_eld, nextraq, omnitracs, onestep, ontime_eld, optima, orbcomm, orient_eld, panda_eld, payd, peak_eld, peoplenet, phillips_connect, phoenix, pop_eld, prologs, proride_eld, qualitylogs_eld, randmcnally, rastrac, raven, redfox, regulog_eld, ridehub, roadeazy, rock_eld, rollingtrans, routemate, royal_eld, safelane, samsara, selectivedrive, simba_eld, skybitz, smart_elds, sparkle_eld, spireon, sun_eld, surfsight, swift, switchboard, synergy_eld, teletracnavman, teletracnavman_director, telogis, tenna, thermo_king, think, tive, topcompliance_eld, traccar, trackease_eld, trackpro, traclog, transflo, trimble, truckford, truckspy, truckx, trueroad_eld, tt, txt_eld, us_fast_eld, verizon_connect, vista_eld, vistracks, vlog_eld, vulcansols_eld, wialon, webfleet, xplore_eld, zigzag_eld, zms_eld, zonar, zubie Unique identifier of the record in the TSP. Note: we generate a unique composite key based on available fields if the TSP does not provide an unique ID.
SHA-256 hash of the source data payload. Note: we use it internally for idempotence and deduplication.
64External fleet reference in the partner system.
The datetime the record was logically deleted from Catena Telematics.
Unique identifier of the TSP at Catena Telematics from which this record was ingested.
Human readable slug of the TSP at Catena Telematics from which this record was ingested.
Raw source payload as ingested from the TSP. Note: use it for audit/debugging.
Datetime of when the underlying event/observation occurred, as reported by the TSP, or the moment it was ingested by us if not available in the source data.
Unique identifier for the execution that ingested this record into Catena Telematics. Note: useful for tracing.
Unique identifier for schedule that triggered this record's execution. Note: useful for tracing.
Additional data available in the TSP (e.g., we may have external_id, provider_resource_id, etc. — this field captures all those extra attributes in a flexible way).
Display name or unit number for the vehicle.
Manufacturer (OEM) of the vehicle.
Manufacturer model or type designation (e.g., 'Class 8 Tractor', 'Pickup').
Model year (four-digit, e.g., 2022).
Vehicle Identification Number (VIN), typically 17 characters; if available.
Engine serial number or engine VIN, if available.
Plate region/subdivision (state/province code, e.g., 'CA', 'ON').
Plate country code (ISO-3166-1 alpha-3, e.g., 'USA', 'CAN').
License plate number (e.g., 'HMT-3570').
Timestamp when this vehicle record became active/in service (UTC).
Timestamp when this vehicle record ended/out of service (UTC).
Indicates whether the vehicle is currently active/in service.
Operational status label (e.g., 'IN_SERVICE', 'OUT_OF_SERVICE', 'MAINTENANCE').
Free-text notes about the vehicle (plain text).
Telematics/ELD device identifier associated with this vehicle, if any.
Telematics/ELD device serial number, if any.
Telematics/ELD device type or model family (vendor-specific).
Telematics/ELD vendor product identifier (catalog/model code).
Total number of axles on the vehicle.
JSON map of group memberships/tags for this vehicle (segmentation/permissions).
External vehicle identifier as known in the TSP or customer's system.
Unit of measure for speed metrics (e.g., 'km/h', 'mph').
Unit of measure for odometer readings (e.g., 'km', 'mi').
Unit of measure for fuel quantities (e.g., 'gallons', 'liters').
Fuel capacity as provided by the source (text with units, e.g., '100 gallons').
Engine/fuel type (e.g., 'diesel', 'gasoline', 'electric', 'hybrid').