RoscoLive API v1.0
  1. Device
RoscoLive API v1.0
  • Authentication
    • Login
    • Logout
    • mark eula as viewed
    • password change
    • password reset
  • Company
    • get camera health error
    • create a company
    • get partner settings
    • get audit logs of a company
    • get input sensors notifications of a company
    • get ignition notifications of a company
    • get a company by ID
    • update a company by ID
    • update company
    • search companies
    • get companies list
    • get a company
    • get companies
    • get partner companies list
    • get own partner company
  • Custom Role Permissions
    • get full list of available custom user permission
  • Device
    • get company devices
      GET
    • search devices
      GET
    • update a device
      POST
    • get a device data usage
      GET
    • Play audible alert sound
      POST
    • get devices data usage
      GET
    • get a company devices by company ID
      GET
    • restart a device
      GET
    • get company devices with modems
      GET
    • get distance
      GET
    • get installed report of a device
      GET
    • get an installed report
      GET
    • merge profile with device config
      POST
    • get audit logs of a device
      GET
    • get list of trip dates for device
      GET
    • get list of trips for passed device and date
      GET
    • Get a device
      GET
    • get list of company devices
      GET
    • get device with driver id
      GET
    • create devices (legacy/DV4)
      PUT
    • create devices (auto-prov/DV6)
      PUT
    • get company device using IMEI/SN
      GET
    • check red bubble in manage vehicles
      GET
    • bulk device creation
      PUT
    • get devices for all companies available for user
      GET
    • get list of trip related snapshots
      GET
    • reset status of sd card
      POST
    • get list of all available dates
      GET
    • get available video list for date
      GET
    • replace device
      POST
    • get replace history by device id
      GET
    • clear device channel status
      POST
    • get camera health error by device id
      GET
    • get camera health definitions
      GET
    • update camera health error by error id
      POST
    • update camera health errors
      POST
    • Get device list for multiple companies
      GET
    • Get current activity status of devices
      GET
  • Device Firmware
    • get available firmware versions
    • get list of latest firmware versions
    • push firmware to device
    • cancel pending firmware update to devices
    • get firmware updates history for company
  • 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 a driver
    • 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
    • Get company events
    • get an event
    • send an event
    • get status of an event
    • Request videos of an event
    • get uploaded videos of an event
    • 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 snapshots of an event or alert
    • get snapshots of an event or alert by company ID
    • get a last event
    • get a last event of devices
    • 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
    • push 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 events for a device
    • 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
    • Get an external service account
    • Pair RL device with external device
    • Get RL device data via external device unique serial number
    • external service login
    • get a device
  • Fleet Configuration
    • Get profiles of a company
    • Create new profile in a company
    • Get a company profile
    • get profile history
    • Update a company profile
  • 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
    • start live streaming
    • stop live streaming
    • start multi-channel live streaming
    • stop multi-channel live streaming
  • Metadata
    • get metadata of a device
    • get metadata of devices
    • Get alerts and events of devices for company
    • get alerts for charts and graphs
    • get metadata of device(s) for last 24 hours
    • get alerts of a device
    • get alerts of a driver
  • Modem Administration
    • get list of available modems
    • upgrade modem firmware
    • upgrade modem firmware for group of devices
  • 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
    • get full list of devices per partner
    • get full list of companies per partner
    • get user custom presets
    • create custom presets
    • update custom preset
    • delete custom preset by name
  • Releases
    • get last release
    • view a release
  • Remote Device Management
    • get config values from device
    • verify of device token
    • get current firmware of devices
    • SD-card formatting
    • get config file for device
  • Statistics
    • get statistics feature usage
  • User
    • get company users
    • Get a user
    • update a user
    • remove a user
    • Get own info
    • create a user
    • get company 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
    • get push notifications
    • set push notifications
    • remove push notifications
  1. Device

Get device list for multiple companies

GET
/devices/list/search
Get a list of devices for multiple companies.
Roles with endpoint access
RolePermission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Query Params
company_ids
string 
required
A comma-separated list of company IDs to return devices for. Requires at least 1 company ID.
Example:
"123456,654321"
search_fields
enum<string> 
optional
A comma-separated list of fields on which to search the search_str param value against. The number of values in this param MUST match number of values in search_str
Allowed values:
device_idvehicle_namegroup_namevin_numberserial_numbertag_plate
Example:
"vehicle_name,group_name"
search_str
string 
optional
A comma-separated list of search values in which to search on in the request. Each value will be searched against the values set in search_fields param.
Example:
"foo,bar"
order_fields
enum<string> 
optional
A comma-separated list of fields to order the returned data by. Number of values passed in this param MUST match number of values in order_dir
Allowed values:
device_idvehicle_namegroup_namevin_numberserial_numbertag_plate
Example:
"vehicle_name,group_name"
order_dir
string 
optional
A comma-separated list of either the value "asc" or "desc" for each field value in search_fields param to control the direction of order for the returned data.
Example:
"asc,desc"
include_data
enum<string> 
optional
A comma-separated list of columns to include in the request.
Allowed values:
data_usagechannel_statusignitiondrivermodemfirmware_versionfirmware_statusgeotabinactive_devicesmodem_rssilive_streamcamera_healthno_sd_card
Example:
"data_usage,channel_status,ignition"
Cookie Params
session
string 
optional
Session cookie returned from login response. Include in cookies for all API calls within user session.
Example:
{{session}}
session_token
string 
optional
Session token returned in login response. Include in cookies for all API calls within user session.
Example:
{{session_token}}

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 GET 'https://fleet.roscolive.com/api/v1.0/devices/list/search?company_ids=&search_fields=&search_str=&order_fields=&order_dir&include_data' \
--header 'Cookie: session={{session}};session_token={{session_token}}'

Responses

🟢200Success
application/json
Body
meta
object 
required
Request metadata object
code
integer 
required
HTTP status code returned by response
>= 100<= 599
response
object 
required
Contains response data
result
enum<string> 
required
"OK" if successful, else "Fail" if error
Allowed values:
OKFail
Example
{
  "meta": {
    "code": 100
  },
  "response": {},
  "result": "OK"
}
🟠401Login Required
🟠404Resource Not Found
🔴500Internal Server Error
Modified at 2024-12-06 04:41:13
Previous
update camera health errors
Next
Get current activity status of devices
Built with