- Authentication
- Company
- Get Camera Health Errors for CompanyGET
- create a companyPUT
- get partner settingsGET
- get audit logs of a companyGET
- get input sensors notifications of a companyGET
- get ignition notifications of a companyGET
- get a company by IDGET
- update a company by IDPOST
- update companyPOST
- search companiesGET
- get companies listGET
- get a companyGET
- get companiesGET
- get partner companies listGET
- get own partner companyGET
- Custom Role Permissions
- Device
- get company devicesGET
- search devicesGET
- update a devicePOST
- get a device data usageGET
- Play in-cab audible alert sound for devicePOST
- get devices data usageGET
- get a company devices by company IDGET
- restart a deviceGET
- get company devices with modemsGET
- get distanceGET
- get installed report of a deviceGET
- get an installed reportGET
- merge profile with device configPOST
- get audit logs of a deviceGET
- get list of trip dates for deviceGET
- get list of trips for passed device and dateGET
- Get a deviceGET
- get list of company devicesGET
- get device with driver idGET
- create devices (legacy/DV4)PUT
- create devices (auto-prov/DV6)PUT
- get company device using IMEI/SNGET
- check red bubble in manage vehiclesGET
- bulk device creationPUT
- get devices for all companies available for userGET
- get list of trip related snapshotsGET
- reset status of sd cardPOST
- get list of all available datesGET
- get available video list for dateGET
- replace devicePOST
- get replace history by device idGET
- clear device channel statusPOST
- get camera health error by device idGET
- get camera health definitionsGET
- update camera health error by error idPOST
- update camera health errorsPOST
- Get device list for multiple companiesGET
- Get current activity status of devicesGET
- Device Firmware
- Driver Scoring / Coaching
- get company drivers list
- get a list of trips
- associate a driver with a trip
- get driver by event_id
- update a driver
- get driver by trip_photo_id
- get driver scores
- add driver photo
- Add New Driver to Company
- remove a driver
- upload a driver from csv file
- get unknown driver trips
- associate trip with the driver.
- Get company event score weights
- Update company event score weights
- Get drivers coaching events
- Event
- Request Custom Snapshots for Time Range
- Request Custom Event
- Get an Event of a Device by Start Time
- Get an Event by ID and Storage Type
- Get Company Events
- Get Event by Company and ID
- send an event
- get status of an event
- Request videos of an event
- Get Uploaded Event Videos
- get events summary of devices
- get events summary of a device
- get a company events by company ID
- get status of an event by company ID
- Get Event Snapshots
- get snapshots of an event or alert by company ID
- get a last event
- Get Latest Event for Each Device in Company
- get events log of a device
- get dates of events
- get events for charts and graphs
- get events for charts and graphs by company ID
- get an event by company ID
- get events summary of a device by company ID
- request videos of an event by company ID
- get dates of an events by company ID
- get a last event of company device
- clear last event
- get dates of events of a device
- Update Custom Event
- delete an event
- request videos of an alert
- share an event
- get an event by a permalink
- get geotab events
- get a last updated event of devices
- download a blocked event
- Get Flagged Company Events
- flag an event
- unflag an event
- generate snapshots
- local geocoding service
- update an event
- get snapshot/location of event
- Get Device Events for Period
- Request custom video from device
- get snapshot on demand
- get an event by a permalink hash
- Set Event Label for Event
- Restore event video from archive
- Add users for notification of event restore from archive
- Add event label
- Add user feedback to event
- Get event user feedback
- Get event filters list for date range in company
- External Service
- Fleet Configuration
- Group
- get company groups
- add a group
- remove a group
- get devices of a group
- add a device to a group
- remove a device from a group
- get users of a group
- add a user to a group
- remove a user from a group
- get company groups by company ID
- add a device to a group by company ID
- get devices of a group by company ID
- remove a device from a group by company ID
- remove a group by company ID
- add a group by company ID
- add an user to a group by company ID
- get users of a group by company ID
- remove an user from a group by company ID
- edit group
- get groups with ID
- get group of a company by group ID
- Live streaming
- Metadata
- Modem Administration
- Report
- get data usage report
- Get custom report data
- get data usage report by device id
- get list of companies with data usage for date range
- get data usage for active devices for specified companies
- get companies with data usage for date range
- get data usage report for devices in company
- get data tracking report
- get all events report
- Get all events report for company
- get vehicle activity report
- get firmware report
- Get event count summary report for company devices
- get driver event breakdown report
- get driver event performance report
- Update custom report
- get custom reports by user email
- get custom report by report id
- put subscribe to a report
- get report subscriptions
- get list of standard reports
- get speeding summary report
- get speeding breakdown report
- get idling summary report
- get idling breakdown report
- Create custom report for user
- Partner Portal
- Releases
- Remote Device Management
- Statistics
- User
- Get Company Users
- Get User Info from Email Address
- Update a User's Info
- remove a user
- Get my Own User Info
- Create a User
- Get Users by Company ID
- get user settings
- set user settings
- Get application notifications
- remove the notification
- mark notifications as viewed
- verify password
- SD card reformat reminder
- Update notification by email
- assign user to company
- get permissions by a user_id
- Get event / sms notification settings
- Webhooks
Login
POST
/login
session and session_token cookie will be returned. Pass these cookies in the request header for any subsequent API requests for actions using this current user session. User session tokens expire after 24 hours in which a Login request will have to be resubmitted to retrieve a new session.Request
Body Params multipart/form-data
email
string <email>
required
password
string <password>
required
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://fleet.roscolive.com/api/v1.0/login' \
--form 'email=""' \
--form 'password=""'Responses
🟢200Login Success
application/json
Body
meta
objectÂ
required
code
integerÂ
optional
response
objectÂ
required
roles
array[string]
required
Allowed values:
partnerpartner_viewcustom_partnerfleet_managergroup_managerusercustom_user
user
stringÂ
required
last_login
string <date-time>
required
Example:
2024-01-01 13:40:14
user_id
integerÂ
required
session_expire
string <date-time>
required
Example:
2024-01-01 13:40:14
session_token
stringÂ
required
Example:
afced4feb4dc4c329abec784b2495243
result
enum<string>Â
required
Allowed values:
OKFailed
Examples
{
"meta": {
"code": 200
},
"response": {
"roles": [
"fleet_manager"
],
"user": "Kianna_Cruickshank@hotmail.com",
"last_login": "1996-03-04 11:08:13",
"user_id": 7,
"session_expire": "2047-09-23 21:13:07",
"session_token": "afced4feb4dc4c329abec784b2495243"
},
"result": "OK"
}🟢202Accepted
🟢200Invalid Credentials
🟠404Resource Not Found
🔴500Internal Server Error
Modified at 2025-01-14 20:04:00