Vehicle Consumptions
Vehicle Consumptions
Retrieve consumption data and tracking for a specific vehicle
GET
Vehicle Consumptions
Vehicle Consumptions
Get detailed consumption records for a specific vehicle. This endpoint returns paginated consumption data including status information about data processing and tracking.Consumption Tracking: This endpoint retrieves consumption records linked to a vehicle, showing fuel usage, mileage, and processing status over time.
Request
Path Parameters
uuid
required
The UUID of the vehicleExample:
550e8400-e29b-41d4-a716-446655440000Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faQuery Parameters
array[string]
Filter by consumption statusAvailable values:
active, success, loading, errorExample: status[]=success&status[]=activearray[uuid]
Filter by unit of measurement UUIDExample:
unit_id[]=550e8400-e29b-41d4-a716-446655440000string
Filter by custom identifierExample:
REF-2024-001date
Filter consumptions starting on or after this date (inclusive)Format:
YYYY-MM-DDdate
Filter consumptions ending on or before this date (inclusive)Format:
YYYY-MM-DDarray[uuid]
Filter by source file UUID. Pass
00000000-0000-0000-0000-000000000000 to filter for records with no file.Example: file_id[]=3fa85f64-5717-4562-b3fc-2c963f66afa6datetime
Filter records created on or after this timestamp (inclusive)Format:
YYYY-MM-DDTHH:MM:SSZdatetime
Filter records created on or before this timestamp (inclusive)Format:
YYYY-MM-DDTHH:MM:SSZstring
Filter by CO2e calculation statusAvailable values:
calculated, not_calculatedstring
Field to sort by. Prefix with
- for descending order. Unrecognized values fall back to the default order (-created_at).Available values: custom_id, quantity, start_date, end_date, status, created_at, updated_at, base_total_spendExample: ?sort=-start_dateinteger
default:"1"
Page number for paginationExample:
2integer
default:"50"
Number of items per page (max 100)Example:
50Response
array[object]
Array of consumption objects
integer
Total number of consumption records
integer
Current page number
integer
Number of items per page
string
16-character hex hash of the applied filters. Pass this to the bulk delete by filters endpoint to ensure consistency.
Example
Successful Response
Consumption Status Reference
Common Errors
401 Unauthorized
Cause: Missing or invalid API key404 Not Found
Cause: Vehicle not found in organization422 Validation Error
Cause: Invalid query parametersactive, success, loading, or error.
Use Cases
Get Successful Consumption Records
Retrieve only successfully processed consumption data:Monitor Consumption Processing
Track consumption records that are being processed:Export Consumption Data
Export consumption records for analysis:Analyze Fuel Efficiency Trends
Track fuel efficiency changes over time:Related Endpoints
List Vehicles
Retrieve all vehicles
Create Vehicle
Add a new vehicle to your fleet
Vehicle Overview
Learn about the Vehicles API
Logistics API
Calculate emissions for shipments
List Vehicle Consumptions (Organization)
List consumptions across every vehicle in the organization, not just one