Quickstart

The Voyomotive REST API allows you to pull data from VOYO devices or interact with the OpenConnect platform. All API requests require an API token and a Voyomotive domain. API tokens and domains can be obtained by completing a short Intake Form.

Name	Description
Authorization	Specifies how API requests are authorized using the OAuth 2.0 standard; we suggest you start here.
Rate Limit	Describes the request frequency limitations imposed per API key to protect system resources and ensure fair usage. Reach out to support@voyomotive.com to obtain an API key with an increased request rate.

Account

The following Account Information endpoints are used for managing account-level metadata. These endpoints are primarily used for administrative configuration and branding, allowing you to customize how your account is represented across applications and user interfaces.

Name	Description
Update Account Info	Update information describing your account.
Upload Account Icon	Upload an avatar that represents your account.

Settings

Account Settings are a set of preferences that affect certain API requests.

Name	Description
Get Settings	Get a list of Account Settings.
Update Settings	Update Account Settings.

Service Interval Settings

When a Vehicle is created, Service Intervals will be automatically created for every Service Interval Setting.

Name	Description
Create Service Interval Setting	Creates a custom service interval that can be automatically applied to a created Vehicle.
Get Service Interval Settings	Get a list of all created custom service intervals.
Remove Service Interval Setting	Remove a created custom service interval.
Update Service Interval Setting	Update a created custom service interval.

OpenConnect

Vehicles

Vehicles represent a real-world car or truck.

Name	Description
Add Vehicle	Connect a User to a Vehicle.
Create Vehicle	Create a Vehicle.
Delete Vehicle	Invalidate a previously created Vehicle.
Get Vehicles	Get a list of Vehicles connected to a provided User.
Remove Vehicle	Disconnect a Vehicle from a User.
Update Vehicle	Update parameter information attributed to a previously created Vehicle.

Users

Users are entities with access to created Vehicles.

Name	Description
Add User	Links two Users; linked Users gain access to any associated Vehicle's data and functionality.
Create User	Create a Voyomotive user account.
Delete User	Invalidate a previously created User.
Get Users	Get a list of all created Users.
Remove User	Remove an assigned User from your account.
Update User	Update parameter information attributed to a previously created User.

Alerts

Events with significance to a Vehicle or connected User.

Name	Description
Create Alert	Create an Alert for a specific Vehicle.
Get Alerts	Get Alerts created for a specific Vehicle.
Update Alert	Update a created Alert.

Service Intervals

A duration of time or amount of miles to travel before a Vehicle requires maintenance.

Name	Description
Create Service Interval	Creates a Service Interval record for a specified Vehicle. Intervals are defined using mileage or time. Intervals trigger service notifications when the scheduled maintenance point is reached.
Generate Service Intervals	Automatically generate a collection of reminders for maintenance based on vehicle manufacturer.
Get Service Intervals	Get Service Intervals created for a specific Vehicle.
Get All Service Intervals	Get all Service Intervals with an optional filter.
Remove Service Interval	Delete a created Service Interval.
Update Service Interval	Update a created Service Interval.

Shops

Represents a service provider that would benefit from updates pertaining to Vehicle Alerts or Service Intervals.

Name	Description
Create Shop	Create a Shop.
Get Shops	Get a list of all Shops with the option to filter by Vehicle or User.
Onboard Shop	Link a Shop with a User/Vehicle pair.
Offboard Shop	Unlink a Shop from a User/Vehicle pair.
Update Shop	Update Shop information.

VOYO Web API

The VOYO Web API provides access to information collected by VOYO devices.

Name	Description
Battery Health	Get short summary of vehicle's 12v battery health.
DTC Freeze Frames	Request for all PIDs requested at the time DTC was set.
Emissions Test Results	Request the current state of your vehicle's emissions testing from a connected VOYO device.
Parameter Data	Request all parameter data for a specific VOYO device over a provided time interval.
ScanPro	Request real-time "scan" from a connected VOYO device.
Supported Features	Request a supported features list from a connected VOYO device.

VOYO Historical API

Name	Description
Device List	Request list of VOYO devices.