Vehicles
List Vehicles
Retrieve a paginated list of vehicles associated with your organization.
The endpoint lists vehicles based on the following criteria:
- Includes only vehicles that have enabled synchronization during the account connection process.
- Excludes disconnected vehicles or those not included in the OEM account.
Returns:
- A paginated response containing a list of vehicles.
Note:
- This endpoint provides a summary of each vehicle's basic details. For comprehensive vehicle data, please refer to the individual vehicle detail endpoints.
Find details on list filter syntax in our documentation here.
Possible Codes in Error Response (see Errors for error response schema and meaning of codes):
- AUTHENTICATION_ERROR
- PAGE_SIZE_TOO_LARGE
- PAGINATED_QUERY_FILTER_CHANGED
- REQUEST_VALIDATION_ERROR
- SERVER_ERROR
get/v1/vehicles
Request
- Base URLhttps://api.volteras.com
- AuthOAuth 2Client credentialsToken URL/v1/oauth2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
maxPageSizeinteger
Max size of the returned list.
pageTokenstring nullable
Page token used for pagination.
filterstring nullable
Listing filter schema.
tagKeystring nullable
tagValuestring nullable
Response
Successful Response
Changes
No recorded changes to this operation across all 18 revisions of this API.