List of Deprecating Resources
Devices API
Vehicle (User Device) Queries 🔐
List All Devices Associated with the User
GET
{baseUrl}/v1/user/devices/me
Lists all devices associated with the authenticated user.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
List All Devices Shared with the User
GET
{baseUrl}/v1/user/devices/shared
Lists all devices shared with the authenticated user.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Device Commands 🔐
Get Aftermarket Device Data by Device Serial Number
GET
{baseUrl}/v1/aftermarket/device/by-serial/{serial}
Retrieves the aftermarket device data for the device serial number.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Get Aftermarket Device Data by Device Serial Number
POST
{baseUrl}/v1/aftermarket/device/by-serial/{serial}/update
Retrieves the aftermarket device data for the device serial number.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Document Operations 🔐
List All Documents for the User
GET
{baseUrl}/v1/documents
Retrieves a list containing all documents for an authorized user.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Get a Document for the User by Document ID
GET
{baseUrl}/v1/documents/{documentId}
Retrieves a document for an authorized user with the provided document ID.
Path Parameters
Name | Type | Description |
---|---|---|
documentId* | String |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Download a Document for the User by Document ID
GET
{baseUrl}/v1/documents/{documentId}/download
Downloads a document for an authorized user with the provided document ID.
Path Parameters
Name | Type | Description |
---|---|---|
documentId* | String |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Upload a New Document for the User
POST
{baseUrl}/v1/documents
Uploads a new document for an authorized user.
⚠️ Body type needs to be form-data
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Request Body
Name | Type | Description |
---|---|---|
file* | File | The file to upload. |
name* | String | The name of the document. |
type* | String | The type of the document. |
userDeviceId | String | Optional user device ID. |
Delete a Document for the User by Document ID
DELETE
{baseUrl}/v1/documents/{documentId}
Deletes a document for an authorized user with the provided document ID.
Path Parameters
Name | Type | Description |
---|---|---|
documentId* | String |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Aftermarket Device Operations
Unclaim the Device by Device Serial Number
POST
{baseUrl}/v1/aftermarket/device/by-serial/{serial}/commands/unclaim
Dev-only endpoint for removing a claim. Removes the flag on-chain and clears the owner in the database.
Path Parameters
Name | Type | Description |
---|---|---|
serial* | String |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Device Data API
Get Daily Distance Driven by User Device ID
GET
{baseUrl}
/v1/user/device-data/{userDeviceId}/daily-distance
Retrieves a daily summary of distances driven (in kilometers) tracked on the user device.
Path Parameters
Name | Type | Description |
---|---|---|
userDeviceId* | String | For |
Query Parameters
Name | Type | Description |
---|---|---|
time_zone* | String | Timezone in TZ Identifier format. Common examples are |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Get Total Distance Driven by User Device ID
GET
{baseUrl}
/v1/user/device-data/{userDeviceId}/distance-driven
Retrieves a total distance driven (in kilometers) tracked on the user device since connection was established. Returns 0
if no odometer data was ever received.
Path Parameters
Name | Type | Description |
---|---|---|
userDeviceId* | String | For |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Device Definitions API
List All Device Definitions
GET
{baseUrl}/device-definitions/all
Retrieves a list of all device definitions.
⚠️ This endpoint returns all the device definitions of all vehicles, the data volume is very large so please handle with care.
List All Available Integrations for a Device Definition by Device Definition ID
GET
{baseUrl}/device-definitions/{deviceDefinitionId}/integrations
Lists all available integrations for a specific device definition by Device Definition ID.
Decode An Array of VINs Returning JSON
POST
{baseUrl}/bulk-decode
Decodes a list of Vehicle Identification Numbers, returning in JSON format.
Request Body
Name | Type | Description |
---|---|---|
vins* | [String] | An array of Vehicle Identification Numbers (VIN). |
Decode An Array of VINs Returning CSV
POST
{baseUrl}/bulk-decode/csv
Decodes a list of Vehicle Identification Numbers, returning in CSV format.
Request Body
Name | Type | Description |
---|---|---|
vins* | [String] | An array of Vehicle Identification Numbers (VIN). |
Users API
Get User's Other Accounts
GET
{baseUrl}/v1/user/check-accounts
Retrieves other connected accounts of the authenticated user.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Last updated