Skip to main content
GET
Get Business Travel Totals
← Business Travels API Returns aggregated statistics for business travels in your organization: total CO2e emitted, total distance traveled, and record count. Supports the same filters as the list endpoint.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Query Parameters

array[string]
Filter by transport typeAvailable values: car, metro, train, trolleybus, bus, motorbike, aircraft, ferryExample: transport_type[]=train&transport_type[]=aircraft
array[string]
Filter by statusAvailable values: active, pending, loading, completed, errorExample: status[]=active
date
Filter by minimum travel date (inclusive)Format: YYYY-MM-DDExample: 2024-01-01
date
Filter by maximum travel date (inclusive)Format: YYYY-MM-DDExample: 2024-12-31
string
Search by name (case-insensitive substring match)Example: offsite
array[string]
Filter by exact name values (multi-select, OR logic)Example: name[]=Team offsite&name[]=Client visit
array[uuid]
Filter by source file UUID. Pass 00000000-0000-0000-0000-000000000000 to filter for records with no associated file.Example: file_id[]=3fa85f64-5717-4562-b3fc-2c963f66afa6
datetime
Filter records created on or after this timestamp (inclusive)Format: YYYY-MM-DDTHH:MM:SSZ
datetime
Filter records created on or before this timestamp (inclusive)Format: YYYY-MM-DDTHH:MM:SSZ
string
Filter by CO2e calculation statusAvailable values: calculated, not_calculated

Response

number
Total CO2e in kg across all matching business travels
number
Total distance in kilometers
integer
Number of business travel records matching the filters

Example

Successful Response

Common Errors

401 Unauthorized

Cause: The key is invalid or revoked (INVALID_API_KEY), expired (API_KEY_EXPIRED), belongs neither to the organization in x-organization-id nor to one of its parents (API_KEY_ORG_MISMATCH, whether or not that organization exists), or has no owner (API_KEY_NO_OWNER). A request carrying no credentials at all answers AUTHENTICATION_REQUIRED. See Errors.

403 Forbidden

Cause: The authenticated user is not a member of the organization

Use Cases

Compare Emissions by Transport Type

List Business Travels

Browse individual travel records

Get Business Travel

Retrieve one travel record by id