List and search vehicles
Returns a paginated, sortable list of the vehicles available in a project.
Returns a paginated, sortable list of the vehicles available in a project. Use the sort query parameter with the format <field>:<asc|desc> (e.g. status:asc, label:desc) to order the result.
Use this to power dropdowns, dispatch boards or fleet-utilization dashboards.
Authorization
api_key The Routal API authenticates requests with an API key passed as the private_key query string parameter. Generate and rotate your keys from the Developer Settings section of your Routal workspace.Never ship API keys to a browser or mobile app — they must stay server-side.
In: query
Query Parameters
Search string
Sort columns
Number of vehicles to skip
0Number of vehicles to fetch
20with deleted vehicles
falseRetrieve only enabled vehicles
falseVehicle project ID
^[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,
"custom_fields": {},
"enabled": true,
"created_by": "4f75d991ac359f8c4c79d762",
"created_at": "2026-05-29T14:55:24.339Z",
"updated_at": "2026-05-29T14:55:24.339Z",
"deleted_at": "2026-05-29T14:55:24.339Z",
"deleted": false
}
]
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}