API ReferenceVehicle
List and search vehicles
Returns a paginated, sortable list of the vehicles in a project.
Returns a paginated, sortable list of the vehicles in a project. Sort with sort=<field>:<asc|desc>, for example status:asc or label:desc.
Authorization
api_key private_key<token>
Pass your API key as the private_key query string parameter. Generate and rotate keys in Developer Settings of your Routal workspace.
Keys stay server-side. Never ship them to a browser or mobile app.
In: query
Query Parameters
text?string
Search string
sort?string
Sort columns
offset?number
Number of vehicles to skip
Default
0limit?number
Number of vehicles to fetch
Default
20deleted?boolean
with deleted vehicles
Default
falseenabled?boolean
Retrieve only enabled vehicles
Default
falseproject_id*string
Vehicle project ID
Match
^[0-9a-f]{24}Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/vehicles?project_id=string"{
"total": 1000,
"limit": 50,
"offset": 25,
"pages": 20,
"page": 1,
"docs": [
{
"id": "4f75d991ac359f8c4c79d762",
"organization_id": "4f75d991ac359f8c4c79d762",
"project_id": "4f75d991ac359f8c4c79d762",
"external_id": "VEH-MAD-02",
"label": "Refrigerated van — Madrid Downtown 02",
"comments": "Access to central depots only before 09:00.",
"phone": "+34612345678",
"email": "carlos.lopez@example.com",
"plate": "2596 KHO",
"fuel_type": "diesel",
"consumption": 8,
"vehicle_model": "Transit Custom L2H2",
"brand": "Ford",
"color": "#1E88E5",
"default_time_window": [
28800,
61200
],
"default_working_days": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
],
"default_min_distance": 5000,
"default_max_distance": 120000,
"default_max_time": 28800,
"default_min_time": 3600,
"default_max_weight": 800,
"default_max_volume": 8,
"default_max_services": 40,
"default_start_location": {
"location_id": "4f75d991ac359f8c4c79d762",
"label": "Location label",
"country": "Spain",
"country_code": "ES",
"state": "Catalonia",
"city": "Barcelona",
"street": "Calle de Pau Claris",
"postal_code": "08302",
"comments": "Location comments",
"lat": 40.45,
"lng": -3.68,
"main_text": "Calle de Pau Claris 12",
"secondary_text": "Barcelona, Catalonia, Spain"
},
"default_end_location": {
"location_id": "4f75d991ac359f8c4c79d762",
"label": "Location label",
"country": "Spain",
"country_code": "ES",
"state": "Catalonia",
"city": "Barcelona",
"street": "Calle de Pau Claris",
"postal_code": "08302",
"comments": "Location comments",
"lat": 40.45,
"lng": -3.68,
"main_text": "Calle de Pau Claris 12",
"secondary_text": "Barcelona, Catalonia, Spain"
},
"default_provides": [
"refrigerated",
"lift_gate"
],
"default_geo_fences": [
"4f75d991ac359f8c4c79d762"
],
"default_break": {
"start": 43200,
"end": 54000,
"duration": 2700
},
"planned_start_time": 23400,
"price_per_distance": 0.00045,
"price_per_minute": 0.0035,
"price_per_stop": 0.5,
"custom_fields": {},
"enabled": true,
"created_by": "4f75d991ac359f8c4c79d762",
"created_at": "2026-09-09T07:20:39.034Z",
"updated_at": "2026-09-09T07:20:39.034Z",
"deleted_at": "2026-09-09T07:20:39.034Z",
"deleted": false
}
]
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}Empty
{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}Empty
Empty