Skip to navigation

Get Fleet Info

Get detailed information about a specific fleet info record.

Authentication

AuthorizationBearer

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

Path parameters

fleet_info_idstringRequiredformat: "uuid"
The unique identifier of the fleet info record.

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

carrier_namestring or nullOptional
Legal or primary carrier name for the fleet.
dot_numberstring or nullOptional
USDOT number associated with the fleet.
dba_namestring or nullOptional

Doing-business-as name for the fleet, if different from the carrier name.

streetstring or nullOptional
Street address for the fleet.
citystring or nullOptional
City portion of the fleet's address.
statestring or nullOptional
State or province portion of the fleet's address.
zipstring or nullOptional
ZIP or postal code for the fleet's address.
countrystring or nullOptional
Country for the fleet's address.
phone_numberstring or nullOptional
Primary phone number for the fleet.
company_urlstring or nullOptional
Primary website URL for the fleet.
timezonestring or nullOptional
Primary timezone for the fleet, ideally as an IANA timezone identifier.

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