Get started
Make your first request
- Have the service provision an approved fleet connection and a consumer API key with access to that connection.
- Use a connection link when customer authorization is needed. Follow the customer onboarding guide for the provider-specific method. A complete session confirms enrollment; wait for separate selected-signal activation and accepted collection before reading data.
- List assets, then use the returned asset ID as
vehicleIdbelow.
curl "$TELEMATICS_ORIGIN/v1/connections/$CONNECTION_ID/vehicles/$VEHICLE_ID/telemetry" \
--header "Authorization: Bearer $TELEMATICS_CONSUMER_KEY"Your backend sends Authorization: Bearer $TELEMATICS_CONSUMER_KEY. Keep the key server-side. A connection ID alone does not grant access. Unknown or ungranted connections return 404; missing or invalid keys return 401.
Set TELEMATICS_ORIGIN to the API origin supplied for your environment, rather than this documentation host. If the API has deployment access protection, your backend also needs the approved server-to-server access configuration. Keep those credentials server-side.
Read profiles and trips
Use List assets with scope=directory for normalized vehicle profiles, then Vehicle profile for a detail. These return vcl_ IDs, also used by trip vehicle references and filters. Default core asset IDs remain the IDs used by telemetry, fault and usage endpoints.
List historical trips, then use a returned trp_ ID with Get trip. Profiles and trips each require their own current purpose approval and fleet-key read grant; core access alone is insufficient. These reads use stored data and do not trigger supplier collection.
curl "$TELEMATICS_ORIGIN/v1/connections/$CONNECTION_ID/trips" \
--header "Authorization: Bearer $TELEMATICS_CONSUMER_KEY"Trip distance is in kilometers and duration is in milliseconds. Use next as cursor with unchanged filters. Driver data and expansions require separate authority; they are absent when unauthorized. See the trip reference for coverage, exclusive time filters and current vehicle expansion.
Choose your next endpoint
Read fault events for service-case triggers, request current meter readings after an app action, or use utilization to compare observed runtime and inactivity.
Availability depends on the deployed release, connection approvals, dataset read grants and completed collection. Confirm the datasets activated for your connection; documentation alone grants no access.