Skip to main content
GET
List Vehicle Consumptions

List Vehicle Consumptions

Retrieve all fuel consumption records for a specific vehicle with pagination support. Vehicle consumptions track fuel usage over time and automatically calculate CO2e emissions based on fuel type and quantity.
Vehicle consumptions represent Scope 1 emissions from mobile combustion. These are typically tracked via fuel purchases, mileage logs, or telematics systems.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: ff4adcc7-8172-45fe-9cf1-e90a6de53aa9
string
required
Your user UUIDExample: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Path Parameters

string
required
UUID of the vehicle to retrieve consumptions forExample: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Query Parameters

integer
default:"1"
Page number for paginationExample: 1
integer
default:"50"
Number of items per page (max: 100)Example: 50
string
Advanced filtering criteria (format: field:operator:value)Supported operators:
  • eq - Equals
  • neq - Not equals
  • gt - Greater than
  • gte - Greater than or equal
  • lt - Less than
  • lte - Less than or equal
Example: "status:active"
string
Sort criteria (format: field:asc or field:desc)Sortable fields:
  • start_date
  • end_date
  • quantity
  • co2e
Example: "start_date:desc"
integer
Filter by start date (Unix timestamp in seconds)Example: 1704067200 (January 1, 2024)
integer
Filter by end date (Unix timestamp in seconds)Example: 1735689600 (January 1, 2025)

Response

integer
Current page number
integer
Number of items per page
integer
Total count of consumption records
integer
Total count of consumption records with errors
array
Array of consumption objects

Consumption Object Fields:

string
Unique consumption record identifier (UUID v4)
string
Vehicle UUID this consumption belongs to
float
Fuel quantity consumed
string
Unit UUID for the quantity
object
Unit details object with id, name, type fieldsCommon units: L (liters), kWh (kilowatt-hours), kg (kilograms)
datetime
Consumption period start date (ISO 8601 format)
datetime
Consumption period end date (ISO 8601 format)
float
Total CO2 equivalent emissions in kg
float
CO2e from fuel consumption (tank-to-wheel emissions)
float
CO2e from fuel production (well-to-tank emissions)
string
Consumption record statusValues:
  • active - Successfully processed
  • error - Processing failed
  • pending - Awaiting processing
string
External reference ID (e.g., from fuel card system, invoice number)
datetime
Record creation timestamp
datetime
Last update timestamp

Example

Successful Response

Common Errors

400 Bad Request

Cause: Invalid query parameters or filter format
Solution: Verify that filter_by and sort_by follow the correct format.

403 Forbidden

Cause: Organization ID doesn’t match your API key or user doesn’t belong to organization
Solution: Verify that x-organization-id matches your API key’s organization.

404 Not Found

Cause: Vehicle ID doesn’t exist or doesn’t belong to your organization
Solution: Verify the vehicle_id exists using the List Vehicles endpoint.

Use Cases

Get Vehicle Fuel History

Display fuel consumption history for a vehicle:

Calculate Average Consumption

Calculate average fuel consumption and emissions:

Filter by Date Range

Get consumptions for a specific period:

Identify Consumption Errors

Find and review consumption records with errors:

Compare Vehicles Fuel Efficiency

Compare consumption patterns across multiple vehicles:

Emission Calculations

Well-to-Wheel (WTW) Methodology

Vehicle consumption emissions are calculated using Well-to-Wheel methodology: Total CO2e = Tank-to-Wheel (TTW) + Well-to-Tank (WTT)
  • Tank-to-Wheel (co2e_consumption): Direct emissions from fuel combustion in the vehicle
  • Well-to-Tank (co2e_generation): Upstream emissions from fuel extraction, refining, and distribution

Emission Factors

Emission factors vary by:
  • Fuel type: Diesel, gasoline, electric, CNG, etc.
  • Vehicle type: Passenger car, light commercial, truck, etc.
  • Country: Regional fuel standards and electricity grid mix
  • Year: Factors updated annually based on latest data
Electric vehicles show emissions in co2e_generation (grid electricity production) while co2e_consumption is zero (no direct tailpipe emissions).

Best Practices

1. Use Pagination for Large Datasets

When a vehicle has many consumption records, paginate through results:

2. Use Date Filtering

Filter server-side instead of loading all data:

3. Monitor Error Status

Regularly check for consumption records with errors:

4. Track by Custom ID

Use custom_id to link consumption records to external systems:

Bulk Upload Consumptions

Upload multiple consumption records via CSV

List Vehicles

View your vehicle fleet

List Vehicle Fuels

Get available vehicle fuels

Authentication

Learn about API authentication