Skip to navigation

Get Vehicle

Get detailed information about a specific vehicle.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

vehicle_idstringRequiredformat: "uuid"
The unique identifier of the vehicle.

Query parameters

include_source_databooleanOptionalDefaults to false

Include the raw data from the telematics provider. Useful for auditing or accessing fields not normalized by Catena

Response

Successful Response
fleet_idstring or nullformat: "uuid"
Internal fleet identifier.
idstringformat: "uuid"
Unique identifier of the record at Catena Telematics.
created_atdatetime

Immutable: The datetime the record was ingested into Catena Telematics.

updated_atdatetime
The dateime the record was last modified in Catena Telematics.
connection_idstringformat: "uuid"

Unique identifier of the connection at Catena Telematics through which this record was ingested. A connection represents a Fleet/TSP pairing.

source_nameenum

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.

source_idstring

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.

source_data_hashstring<=64 characters

SHA-256 hash of the source data payload. Note: we use it internally for idempotence and deduplication.

fleet_refstring or nullOptional
External fleet reference in the partner system.
deleted_atdatetime or nullOptional
The datetime the record was logically deleted from Catena Telematics.
tsp_idstring or nullOptionalformat: "uuid"
Unique identifier of the TSP at Catena Telematics from which this record was ingested.
tsp_slugstring or nullOptional
Human readable slug of the TSP at Catena Telematics from which this record was ingested.
source_datamap from strings to anyOptional

Raw source payload as ingested from the TSP. Note: use it for audit/debugging.

occurred_atdatetime or nullOptional

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.

execution_idstring or nullOptionalformat: "uuid"

Unique identifier for the execution that ingested this record into Catena Telematics. Note: useful for tracing.

schedule_idstring or nullOptionalformat: "uuid"

Unique identifier for schedule that triggered this record’s execution. Note: useful for tracing.

extrasmap from strings to any or nullOptional

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).

vehicle_namestring or nullOptional
Display name or unit number for the vehicle.
oemstring or nullOptional

Manufacturer (OEM) of the vehicle.

model_typestring or nullOptional

Manufacturer model or type designation (e.g., ‘Class 8 Tractor’, ‘Pickup’).

model_yearinteger or nullOptional

Model year (four-digit, e.g., 2022).

vinstring or nullOptional

Vehicle Identification Number (VIN), typically 17 characters; if available.

engine_vinstring or nullOptional
Engine serial number or engine VIN, if available.
license_plate_regionstring or nullOptional

Plate region/subdivision (state/province code, e.g., ‘CA’, ‘ON’).

license_plate_countrystring or nullOptional

Plate country code (ISO-3166-1 alpha-3, e.g., ‘USA’, ‘CAN’).

license_plate_numberstring or nullOptional

License plate number (e.g., ‘HMT-3570’).

started_atdatetime or nullOptional

Timestamp when this vehicle record became active/in service (UTC).

ended_atdatetime or nullOptional

Timestamp when this vehicle record ended/out of service (UTC).

is_activeboolean or nullOptional

Indicates whether the vehicle is currently active/in service.

statusstring or nullOptional

Operational status label (e.g., ‘IN_SERVICE’, ‘OUT_OF_SERVICE’, ‘MAINTENANCE’).

notesstring or nullOptional

Free-text notes about the vehicle (plain text).

eld_idstring or nullOptional

Telematics/ELD device identifier associated with this vehicle, if any.

eld_serial_numberstring or nullOptional

Telematics/ELD device serial number, if any.

eld_device_typestring or nullOptional

Telematics/ELD device type or model family (vendor-specific).

eld_product_idstring or nullOptional

Telematics/ELD vendor product identifier (catalog/model code).

total_axlesinteger or nullOptional
Total number of axles on the vehicle.
vehicle_groupsmap from strings to any or nullOptional

JSON map of group memberships/tags for this vehicle (segmentation/permissions).

external_idstring or nullOptional
External vehicle identifier as known in the TSP or customer's system.
speed_unitstring or nullOptional

Unit of measure for speed metrics (e.g., ‘km/h’, ‘mph’).

odometer_unitstring or nullOptional

Unit of measure for odometer readings (e.g., ‘km’, ‘mi’).

fuel_unitstring or nullOptional

Unit of measure for fuel quantities (e.g., ‘gallons’, ‘liters’).

fuel_capacitystring or nullOptional

Fuel capacity as provided by the source (text with units, e.g., ‘100 gallons’).

engine_typestring or nullOptional

Engine/fuel type (e.g., ‘diesel’, ‘gasoline’, ‘electric’, ‘hybrid’).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
501
Not Implemented Error