Query connected vehicle list
To retrieve a list of connected vehicles use the connectedVehicleList
operation. This operation will only fetch the vehicles that are available within the provided authorization token.
Query
To query connected vehicles call the operation with the necessary fields.
Arguments
filter • ConnectedVehicleListFilter
Filter connectedVehicleList result.
size • Int
Number of elements (count) to return.
Default • 10
page • Int
Page number to return.
Default • 0
Frequently used fields
id • ID
Unique ID of the connected vehicle
vehicle_id • ID
Unique ID of the vehicle
status • ConnectedVehicleStatus
Status of the connected vehicle
Show ConnectedVehicleStatus enum values
Other fields
provider • CarConnectivityProvider
Connectivity provider
Show CarConnectivityProvider enum values
scope • ConnectScope
Scope for accessing the vehicle
Show ConnectScope enum values
label • String
Custom label for a connected vehicle that can be assigned by a user
vin • String
Vehicle identification number, unique identifier for a vehicle
Response
A response can either contain a data
or an
errors
object. The response header will always return
200
as a status code.
Data object
When successful, a data
object will be returned with the
requested fields. If there are no fields present the
data
object will return the operation name with the
appropriate return type. If the operation was a query, this output
will be an object of the schema’s query root type; if the operation
was a mutation, this output will be an object of the schema’s mutation
root type.
Error object
If unsuccessful, an errors
object will be returned with
more details in the extensions
object. The error object
can contain any of the following objects.
Error
AUTH_TOKEN_EXPIRED
The token you provided is expired.
Error
AUTH_TOKEN_INVALID
The token you provided is invalid.
Error
OPERATION_NOT_ALLOWED
You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.