Jump to Content
Guides
API Reference
Changelog
Event Reference
Log In
API Reference
Log In
Guides
API Reference
Changelog
Event Reference
Overview
All
Pages
Start typing to search…
JUMP TO
SCALAR APIs
Introduction
Authentication
Authentication
Retrieves the access token
post
Activity Definition Manager
Overview
Activity definitions
Retrieves activity definitions
get
Actions
Assigns assets to an activity definition profile
post
Activity definition profiles
Retrieves activity definition profiles
get
Retrieves an activity definition profile by ID
get
Alarm Center
Overview
Alarms
Retrieves alarms
get
Supported alarms
Alarms
Overview
Trailer alarms
Retrieves a list of alarms
get
Retrieves alarms list of an asset
get
Assets
Overview
Assets
Retrieves assets.
get
Retrieves specific asset.
get
Creates asset.
post
Updates an asset.
patch
Asset settings
Retrieves asset settings.
get
Creates asset settings for organization.
post
Updates an asset setting.
patch
Asset configurations
/v1/assets/configurations
get
Brake Performance
Overview
EBPMS state change
Returns the current brake system state per fleet based on token organization ID.
get
Returns the current brake system state per asset ID
get
Enables EBPMS for asset
post
Disables EBPMS for asset
post
EBPMS performance data
Return the list of brake performance values per fleet based on token organization ID.
get
Data Sharing
Overview
Framework agreements
Fetches list of framework agreements.
get
Fetches framework agreement details by framework agreement ID.
get
Fetches integrator details by framework agreement ID.
get
Creates framework agreement.
post
Contracts
Fetches list of contracts.
get
Fetches contract details by ID.
get
Creates contract.
post
Sessions
Fetches list of sessions.
get
Fetches session details by ID.
get
Create session
post
Updates session.
patch
Actions
Stops framework agreement.
post
Stops contract
post
Stops session
post
Starts session.
post
Extends contract.
post
Approves framework agreement.
post
Rejects framework agreement.
post
Profile
Fetches profile details for an organization.
get
Diagnostic Trouble Code (DTC)
Overview
Assets
Retrieves DTC ledger entries for a single asset.
get
Retrieves DTC ledger entries for multiple assets.
get
Documents
Overview
Document
Retrieves a list of documents for an organization and a range.
get
Retrieves a document.
get
Retrieves file(s)
get
Generates a pdf document.
get
Drivers
Overview
Drivers
Retrieves a list of all drivers.
get
Retrieves details of a driver.
get
Creates a driver.
post
Updates details of a driver.
patch
Deletes a driver.
del
Driving and Resting Times
Overview
Remaining times
Retrieves a list of remaining times for the given driver(s)
get
EBS
Overview
Trailer EBS
Retrieves a list of EBS.
get
Retrieves EBS details of an asset.
get
Eco Performance
Overview
Profiles
Retrieves a list of Eco profiles.
get
Returns default Eco profile.
get
Returns an Eco profile for the provided profileId.
get
Creates an Eco profile.
post
Updates the required Eco profile.
patch
Deletes the required Eco profile.
del
Eco Performance
Retrieves the Eco performance.
get
Reports
Retrieves a list of Eco monitor performance items.
get
Fleet Installer
Overview
Fleet Installer
Retrieves health diagnostics data.
get
Starts unit diagnostics session.
post
Stops unit diagnostics session.
post
Detects rf sensors.
post
Sets rf sensors configuration.
post
Groups
Overview
Assets
Retrieves asset groups of a specific organization.
get
Retrieves detailed information of a specific asset group.
get
Creates an asset group.
post
Assigns assets to an asset group.
post
Unassigns assets from an asset group.
post
Deletes an asset group.
del
Updates an asset group.
patch
Places
Retrieves place groups of a specific organization.
get
Retrieves detailed information of a specific place group.
get
Creates a place group.
post
Assigns places to a place group.
post
Unassigns places from a place group.
post
Updates a place group.
patch
Deletes a places group.
del
Drivers
Retrieves driver groups of a specific organization.
get
Retrieves detailed information of a specific driver group.
get
Creates a driver group.
post
Assigns drivers to a driver group.
post
Unassigns drivers from a driver group.
post
Updates a driver group.
patch
Deletes a driver group.
del
Messaging
Overview
Contacts
Retrieves a contacts list
get
Conversations
Get all conversations for organization
get
Messages
Retrieves messages from multiple conversations (org-scoped batch)
get
Retrieves attachment details
get
Sends a new message
post
People Mobility - Booking
Overview
Bookings
Return a list of paginated bookings
get
Retrieve information about a booking
get
Create a booking
post
Cancel a booking
post
Rides
Retrieve information about a vehicle associated to a ride
get
Quotes
Generate one or more quotes
post
Vehicles
Retrieve the details of one or more vehicles
get
PKI Certificate
Overview
CSR
Retrieves a list of CSRs.
get
Retrieves the certificate for the given CSR ID
get
Initiate Certificate Generation.
post
Places
Overview
Place
Retrieves a list of places.
get
Retrieves a place by ID.
get
Creates a place.
post
Updates a place.
patch
Updates a place.
put
Deletes a place.
del
Subscription
Retrieves alarm definition (subscriptions).
get
Creates an alarm definition (subscription).
post
Updates an alarm definition (subscription).
put
Deletes an alarm definition.
del
Positions
Overview
Trailer positions
Retrieves a list of positions.
get
Retrieves positions list of an asset.
get
Precomputed Route Service
Overview
Precomputed routes
Store a new precomputed route
post
Reseller Management
Overview
Organizations
Retrieves list of organizations.
get
Retrieves detailed information for the requested organization.
get
Creates a new organization.
post
Updates the organization name.
patch
Subscriptions
Retrieves subscriptions of an organization.
get
Assigns packages to an organization.
post
Update existing subscription of an organization.
put
Delete subscription for an organization.
del
Scheduled Trips
Overview
Trip
Retrieves a scheduled trip.
get
Creates a trip.
post
Updates a trip.
put
Deletes a scheduled trip.
del
Sensors
Overview
Supported sensor IDs
Subscriptions - Getting Started
Sensors
Retrieves all available sensorIDs.
get
Retrieves all sensor between last call time and current time.
get
Retrieves last sensor value.
get
Retrieves sensor data for specified interval.
get
Resets last feed call time for a subscriptionID.
patch
Subscriptions
V1
Retrieves all subscriptions of the integrator calling the endpoint.
get
Retrieves subscription details for subscriptionID.
get
Creates a subscription.
post
Creates a subscription.
patch
Deletes the provided subscriptionId.
del
V2
Retrieves all subscriptions of the integrator calling the endpoint.
get
Retrieves subscription details for subscriptionID.
get
Creates a subscription.
post
Updates the provided subscription settings replacing sensorIds and assetIds.
patch
Deletes the provided subscriptionId.
del
Spot Subcontracting
Overview
Planning
Retrieves a trip.
get
Retrieves the file(s).
get
Retrieves the signature(s).
get
Creates a trip.
post
Updates a trip.
put
Tacho Management
Overview
Archives
Retrieves the organization archives.
get
Retrieves the archives for drivers.
get
Retrieves the archives for assets.
get
Teams
Overview
Teams
Retrieves all teams OR teams for the specific organization.
get
Creates a team.
post
Deletes team for the team ID.
del
Updates team for the team ID.
patch
Asset groups
Retrieves list of asset group IDs assigned to a team.
get
Assigns asset groups to a team.
post
Unassigns asset groups from a team.
post
Driver groups
Retrieves list of driver group IDs assigned to given team.
get
Assigns driver groups to a team.
post
Unassigns driver groups from a team.
post
Place groups
Retrieves list of place group IDs assigned to the team.
get
Assigns place groups to a team.
post
Unassigns place groups from a team.
post
Users
Retrieves all users assigned to a team OR users of a specific team.
get
Assigns user(s) to a team
post
Unassigns user(s) from a team.
post
Integrators
Retrieves integrators list of a team.
get
Assigns integrators to a team.
post
Unassigns integrators from a team.
post
tRACK & TRACE
Overview
Current activities
Retrieves the open activities for the provided assets or drivers.
get
Historical activities
Retrieves all the activities for an asset or a driver for the given period.
get
Current positions
Retrieves the current positions for the provided assets.
get
Historical positions
Retrieves all positions for an asset for the given period.
get
Historical Activity Context Events
Retrieves all the activity-context-events for an asset or a driver for the given period.
get
Users
Overview
M2M integrators
Retrieves a list of M2M integrators.
get
Retrieves specific M2M details.
get
Creates a new machine to machine (M2M) integrator.
post
Updates specified M2M integrator.
patch
Deletes specified M2M integrator.
del
Roles
Retrieves all roles for the specified organization.
get
Users
Retrieves a list of users for a specific organization.
get
Retrieves specific user details.
get
Creates new user and assigns a role.
post
Updates a user.
patch
Deletes specified user.
del
Workflows
Overview
Workflows
Retrieves the workflows.
get
Workflow sessions
Retrieves a specific workflow feedback
get
Powered by
Overview
Ask AI
Provides an overview of the Spot subcontracting module
