HomeGuidesAPI ReferenceSupport
API Reference
Contact

List Vehicles (Paginate)

get
https://wh.route4me.com/modules/api/v5.0/vehicles/paginate

Get the paginated list of Vehicles. This endpoint retrieves detailed information with filtering and pagination options.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

The requested page.

integer
≥ 1
Defaults to 100

The number of items per page.

order_by
array of arrays

Array of field and direction to order by. Example: [["field_name","asc"]]

order_by
string
enum

Choose a scope to get. Available scopes are — pending, deleted, and active (default)
Default value : active

Allowed:
string
length ≤ 200

Search in the Vehicles by the corresponding query phrase.

string

Additional query string

boolean

Return only is_operational vehicles.

boolean

Return only vehicles with profile.

boolean

Return multi unit fields in response.

telematics_connection_ids
array of integers

Return vehicles linked by telematics.

telematics_connection_ids
facility_ids
array of strings

Filter by facility IDs

facility_ids
Responses

Updated 5 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago