Vehicles
Retrieve a list of vehicles
Required scope: vehicles:read
query Parameters
ownerTypeFilter by owner type of the vehicle
pagePage number to retrieve (starts with 0)
perPageNumber of items per page (between 1 and 100, default 10)
ownerIdFilter to retrieve vehicles with specified team ID or user ID defined by ownerType
Retrieve a list of vehicles › Responses
List of vehicles that match the criteria
Create a vehicle
Required scope: vehicles:write
Create a vehicle › Request Body
nameName of the vehicle
teamIdId of the team the vehicle belongs to
modelIdId of the vehicle model
licensePlateLicense plate of the vehicle
brandManual vehicle brand name. Required when modelId is not provided.
modelNameManual vehicle model name. Required when modelId is not provided.
vehicleTypeVehicle type. Required when modelId is not provided.
vid^VID:[0-9A-Fa-f]{6,2…VID identifier for auto-charge. Format: VID:xxxxxxxxxxxx
Create a vehicle › Responses
Vehicle created
Retrieve a list of vehicle brands
Required scope: vehicles:read
query Parameters
ownerTypeFilter by owner type of the vehicle
pagePage number to retrieve (starts with 0)
perPageNumber of items per page (between 1 and 100, default 10)
ownerIdFilter to retrieve vehicles with specified team ID or user ID defined by ownerType
Retrieve a list of vehicle brands › Responses
List of all available vehicle brands
Retrieve a list of vehicle connectors
Required scope: vehicles:read
query Parameters
ownerTypeFilter by owner type of the vehicle
pagePage number to retrieve (starts with 0)
perPageNumber of items per page (between 1 and 100, default 10)
ownerIdFilter to retrieve vehicles with specified team ID or user ID defined by ownerType
Retrieve a list of vehicle connectors › Responses
List of all available vehicle connectors
Retrieve a single vehicle integration
Required scope: vehicle:read
path Parameters
integrationIdquery Parameters
ownerIdFilter to retrieve vehicles with specified team ID or user ID defined by ownerType
ownerTypeFilter by owner type of the vehicle
Retrieve a single vehicle integration › Responses
Vehicle integration with provided id
idId of the vehicle integration
lastSeenAtVehicle was last seen at
vinVehicle identification number
odometerOdometer in Km
Charge state of the vehicle
Location of the vehicle. It is available only if the necessary permissions have been granted and applies exclusively to team-owned vehicles, not end-user vehicles.
Create a vehicle authorization link
Required scope: vehicles:write. Returns the link an application user follows to authorize their vehicle account (e.g. Enode or Smartcar) so it can be connected to Monta.
Create a vehicle authorization link › Request Body
userIdId of the application user the authorization link is created for
redirectUri^https://\S+$ · requiredURI the user is redirected to after authorizing their vehicle account. Must be an https:// URL.
providerenode|smartcarVehicle integration provider. Defaults to enode when omitted.
brandIdVehicle brand id used to pick a provider-specific authorization flow
scopesScopes requested from the vehicle account. Defaults to charge-state and control-charging. charge-state also grants the odometer, location the vehicle's location, all every scope. Smartcar always requests every scope.
Create a vehicle authorization link › Responses
Authorization link created
authorizeLinkLink the user follows to authorize their vehicle account
providerVehicle integration provider that issued the link
authFlowAuthorization flow the client should use to complete linking
tokenToken identifying the authorization session
Retrieve a list of vehicle models
Required scope: vehicles:read
query Parameters
ownerTypeFilter by owner type of the vehicle
pagePage number to retrieve (starts with 0)
perPageNumber of items per page (between 1 and 100, default 10)
ownerIdFilter to retrieve vehicles with specified team ID or user ID defined by ownerType
Retrieve a list of vehicle models › Responses
List of vehicle models matching the criteria
Retrieve a single vehicle model
Required scope: vehicles:read
path Parameters
modelIdRetrieve a single vehicle model › Responses
Vehicle model with the provided id
Brand of the vehicle model
modelModel name
displayNameDisplay name of the vehicle model
List of connectors supported by this vehicle model
idId of the vehicle model
variantVariant of the vehicle model
releaseYearRelease year of the vehicle model
pictureUrlURL of the vehicle model picture
capacityKwhBattery capacity in kWh
maxKwAcMaximum AC charging power in kW
maxKwDcMaximum DC charging power in kW
Retrieve a single vehicle
Required scope: vehicle:read
path Parameters
vehicleIdRetrieve a single vehicle › Responses
Vehicle integration with provided id
idId of the vehicle
teamIdTeam Id that the vehicle belongs to
userIdUser Id that the vehicle belongs to
nameName of the vehicle, can be customized by the user
licensePlateLicense plate of the vehicle
batteryCapacityKwhBattery capacity of the vehicle in Kwh
maxPowerKwAcMaximum AC charging power (in kW) that the vehicle can accept when charging via an AC charger
maxPowerKwDcMaximum DC charging power (in kW) that the vehicle can accept when using a DC fast charger
displayNameDisplay name of the vehicle
integrationIdId of the vehicle integration
integrationStatusStatus of the vehicle integration
manuallyConfiguredAtTimestamp when the vehicle was manually configured (null if using catalog model)
Custom specification for manually configured vehicles
vidVID identifier for auto-charge
Update a vehicle
Required scope: vehicles:write
path Parameters
vehicleIdUpdate a vehicle › Request Body
nameName of the vehicle
modelIdId of the vehicle model. Omit or leave null to keep the existing value.
teamIdId of the team the vehicle belongs to
licensePlateLicense plate of the vehicle
brandManual vehicle brand name.
modelNameManual vehicle model name.
vehicleTypeVehicle type.
vid^$|^VID:[0-9A-Fa-f]{…VID identifier for auto-charge. Format: VID:xxxxxxxxxxxx. Send an empty string to remove the vehicle's VID.
Update a vehicle › Responses
Vehicle updated
idId of the vehicle
teamIdTeam Id that the vehicle belongs to
userIdUser Id that the vehicle belongs to
nameName of the vehicle, can be customized by the user
licensePlateLicense plate of the vehicle
batteryCapacityKwhBattery capacity of the vehicle in Kwh
maxPowerKwAcMaximum AC charging power (in kW) that the vehicle can accept when charging via an AC charger
maxPowerKwDcMaximum DC charging power (in kW) that the vehicle can accept when using a DC fast charger
displayNameDisplay name of the vehicle
integrationIdId of the vehicle integration
integrationStatusStatus of the vehicle integration
manuallyConfiguredAtTimestamp when the vehicle was manually configured (null if using catalog model)
Custom specification for manually configured vehicles
vidVID identifier for auto-charge
Connect a vehicle integration
Required scope: vehicles:write
path Parameters
vehicleIdintegrationIdConnect a vehicle integration › Responses
Vehicle with the connected integration
idId of the vehicle
teamIdTeam Id that the vehicle belongs to
userIdUser Id that the vehicle belongs to
nameName of the vehicle, can be customized by the user
licensePlateLicense plate of the vehicle
batteryCapacityKwhBattery capacity of the vehicle in Kwh
maxPowerKwAcMaximum AC charging power (in kW) that the vehicle can accept when charging via an AC charger
maxPowerKwDcMaximum DC charging power (in kW) that the vehicle can accept when using a DC fast charger
displayNameDisplay name of the vehicle
integrationIdId of the vehicle integration
integrationStatusStatus of the vehicle integration
manuallyConfiguredAtTimestamp when the vehicle was manually configured (null if using catalog model)
Custom specification for manually configured vehicles
vidVID identifier for auto-charge
Retrieve the users a vehicle is shared with
Required scope: vehicles:read
path Parameters
vehicleIdquery Parameters
pagePage number to retrieve (starts with 0)
perPageNumber of items per page (between 1 and 100, default 10)
Retrieve the users a vehicle is shared with › Responses
List of users the vehicle is shared with
Share a vehicle with a user
Required scope: vehicles:write. Shares the vehicle with the given user. The user must belong to the vehicle's team or already be a shared user. Idempotent.
path Parameters
vehicleIdquery Parameters
pagePage number to retrieve (starts with 0)
perPageNumber of items per page (between 1 and 100, default 10)
Share a vehicle with a user › Request Body
userIdId of the user to share the vehicle with. Must belong to the vehicle's team or already be a shared user.
Share a vehicle with a user › Responses
Updated list of users the vehicle is shared with
Remove a user from a shared vehicle
Required scope: vehicles:write. Stops sharing the vehicle with the given user. Removing the current owner also clears ownership. Idempotent.
path Parameters
vehicleIduserIdquery Parameters
pagePage number to retrieve (starts with 0)
perPageNumber of items per page (between 1 and 100, default 10)
Remove a user from a shared vehicle › Responses
Updated list of users the vehicle is shared with
Transfer vehicle ownership
Required scope: vehicles:write. Transfers ownership of the vehicle to the given user, who must already be one of the vehicle's shared users.
path Parameters
vehicleIduserIdTransfer vehicle ownership › Responses
Vehicle with the new owner
idId of the vehicle
teamIdTeam Id that the vehicle belongs to
userIdUser Id that the vehicle belongs to
nameName of the vehicle, can be customized by the user
licensePlateLicense plate of the vehicle
batteryCapacityKwhBattery capacity of the vehicle in Kwh
maxPowerKwAcMaximum AC charging power (in kW) that the vehicle can accept when charging via an AC charger
maxPowerKwDcMaximum DC charging power (in kW) that the vehicle can accept when using a DC fast charger
displayNameDisplay name of the vehicle
integrationIdId of the vehicle integration
integrationStatusStatus of the vehicle integration
manuallyConfiguredAtTimestamp when the vehicle was manually configured (null if using catalog model)
Custom specification for manually configured vehicles
vidVID identifier for auto-charge