Skip to main content

Get all vehicles

GET {{base_url}}/vehicles

Description

This API endpoint is used to search for vehicles based on various criteria such as country code, page number, page size, model, manufacturer, year, type, license plate, start date, and end date.

Request Headers:

NameDescription
countryCode(required, header) The country code associated with the request.

Query Parameters:

NameDescription
pageNumberPage number for paginated results.
pageSizeNumber of results per page.
modelFilter by vehicle model.
manufacturerFilter by vehicle manufacturer.
yearFilter by manufacturing year.
typeFilter by vehicle type.
licensePlateFilter by license plate number.
startDateFilter by start date.
endDateFilter by end date.

Responses:

Status Code 200 Description: Vehicles found successfully.

Response Body Schema:

{
"status": "boolean",
"statusCode": "integer",
"message": "string",
"data": {},
"errors": [
{
"message": "string",
"descriptiveMessage": "string"
}
]
}

Example:

<searchVehiclesResponse>
<status>true</status>
<statusCode>0</statusCode>
<message>string</message>
<data></data>
<errors>
<error>
<message>string</message>
<descriptiveMessage>string</descriptiveMessage>
</error>
</errors>
</searchVehiclesResponse>

400 Bad Request Description: Invalid reference supplied.

404 Not Found Description: Vehicles not found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request GET \ 
--url /vehicles \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!