Jump to Content

Guides API Reference Changelog Event Reference

API Reference

Guides API Reference Changelog Event Reference

All

Pages

Start typing to search…

SCALAR APIs

Introduction

Authentication

Authentication
- Retrieves the access tokenpost

Activity Definition Manager

Overview
Activity definitions
- Retrieves activity definitionsget
Actions
- Assigns assets to an activity definition profilepost
Activity definition profiles
- Retrieves activity definition profilesget
- Retrieves an activity definition profile by IDget

Alarm Center

Overview
Supported alarms
Alarms
- Retrieves alarmsget

Alarms

Overview
Trailer alarms
- Retrieves a list of alarmsget
- Retrieves alarms list of an assetget

Assets

Overview
Assets
Asset settings
Asset configurations
- /v1/assets/configurationsget

Asset Insights Diagnostic Trouble Code (DTC) API

Overview
Assets
- Retrieves DTC ledger entries for a single asset.get
- Retrieves DTC ledger entries for multiple assets.get

Brake Performance

Overview
EBPMS state change
EBPMS performance data
- Return the list of brake performance values per fleet based on token organization ID.get

Data Sharing

Overview
Framework agreements
Contracts
Sessions
Actions
Profile
- Fetches profile details for an organization.get

Documents

Overview
Document

Drivers

Overview
Drivers

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
Eco Performance
- Retrieves the Eco performance.get
Reports
- Retrieves a list of Eco monitor performance items.get

Fleet Installer

Overview
Fleet Installer

Groups

Overview
Assets
Places
Drivers

People Mobility - Booking

Overview
Bookings
Rides
- Retrieve information about a vehicle associated to a rideget
Quotes
- Generate one or more quotespost
Vehicles
- Retrieve the details of one or more vehiclesget

PKI Certificate

Overview
CSR

Places

Overview
Place
Subscription

Positions

Overview
Trailer positions
- Retrieves a list of positions.get
- Retrieves positions list of an asset.get

Reseller Management

Overview
Organizations
Subscriptions

Scheduled Trips

Overview
Trip

Sensors

Overview
Supported sensor IDs
Subscriptions - Getting Started
Sensors
Subscriptions
- V1
- V2

Spot Subcontracting

Overview
Planning

Tacho Management

Overview
Archives

Teams

Overview
Teams
Asset groups
Driver groups
Place groups
Users
Integrators

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
Roles
- Retrieves all roles for the specified organization.get
Users

Workflows

Overview
Workflows
- Retrieves the workflows.get
Workflow sessions
- Retrieves a specific workflow feedbackget

Powered by

Retrieves a document.

get

https://documents.api.eu1.scalar.zf.com/v1/documents/{documentId}

📘
The rate limit for this API is low.

Language

Click Try It! to start a request and see the response here!