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 list of company devices

GET
/companies/{company_id}/devices/list
devicelist
Get list of company devices using company ID.

Request

Path Params
company_id
string 
required
Company ID of company to get list of devices from
Example:
2789
Query Params
include_data
string 
optional
An array of data fields to include in the response. These should be formatted as a comma-seperated string.
latest_hdderror
data_usage
channel_status
ignition
inactive (will include inactive devices in response)
driver
modem
firmware_version
sd_status
firmware_status
live_stream
no_sd_card
Example:
latest_hdderror,data_usage,ignition
page_size
integer 
optional
Pagination page size
Example:
50
page_number
integer 
optional
Pagination page number
Example:
1

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/companies/2789/devices/list?include_data=latest_hdderror,data_usage,ignition&page_size=50&page_number=1'

Responses

🟢200get list of company devices
application/json
Body
meta
object 
required
code
integer 
required
response
object 
required
devices
array [object {43}] 
required
result
string 
required
"OK" if request successful, otherwise "Fail"
Example
{
  "meta": {
    "code": 200
  },
  "response": {
    "devices": [
      {
        "activated_timestamp": "2024-01-01T17:46:31.0Z",
        "active": true,
        "adas_camera_height": 150,
        "adas_camera_offset": 0,
        "adas_units": "imperial",
        "adas_vehicle_hood_len": 150,
        "adas_vehicle_width": 170,
        "canbus": "0",
        "channel_available": "1,2",
        "device_id": "3295982673",
        "device_type": "dv6",
        "disable_live_stream": true,
        "driver_id": null,
        "driver_name": "numquam animi adipisci",
        "firmware_status": "in sunt labore",
        "general_status": "driving",
        "gps_online": true,
        "group_name": "Master",
        "installed_id": 7918695,
        "last_connected_ts": "2024-01-01T17:46:31.0Z",
        "last_disconnected_ts": "2024-01-01T17:46:31.0Z",
        "last_sleep_connected_ts": "2024-01-01T17:46:31.0Z",
        "last_sleep_disconnected_ts": "2024-01-01T17:46:31.0Z",
        "no_sd_card": null,
        "online": true,
        "pending_company_profile": "Default",
        "serial_number": "015974000000301",
        "sleep": 0,
        "tag_plate": "ABC123",
        "timezone": "\"US/Eastern\"",
        "uploaded_company_profile": "Default",
        "vehicle_icon": "van",
        "vehicle_name": "Truck 1",
        "vin_number": "JT2BG22K3Y0485107",
        "channel_status": [
          {
            "channel": 1,
            "check_type": "live",
            "fail_snapshot_link": "http://bowed-instance.biz",
            "fail_status": "solid",
            "fail_ts": "1948-04-24T22:46:47.253Z",
            "success_ts": "2013-10-08T02:00:43.036Z"
          },
          {
            "channel": 1,
            "check_type": "live",
            "fail_snapshot_link": "https://squiggly-cost.org",
            "fail_status": "solid",
            "fail_ts": "1944-11-21T22:44:30.452Z",
            "success_ts": "1976-08-11T15:38:54.445Z"
          },
          {
            "channel": 1,
            "check_type": "live",
            "fail_snapshot_link": "http://left-culvert.org",
            "fail_status": "solid",
            "fail_ts": "1969-12-18T01:37:23.165Z",
            "success_ts": "2006-04-12T16:16:37.923Z"
          }
        ],
        "firmware_version": {
          "firmware": null,
          "gps": "in reprehenderit",
          "mcu": null,
          "mcu_pending": "sit do ullamco",
          "pdc": "ut",
          "pdc_pending": null,
          "uboot": null,
          "uboot_pending": "culpa cillum"
        },
        "ignition": {},
        "latest_hdderror": {
          "count": 0,
          "first_ts": "2024-01-01T17:32:41.0Z",
          "last_ts": "2024-01-01T17:32:41.0Z"
        },
        "live_stream": {
          "duration_month": 46298793,
          "live_stream_access": false
        },
        "modem": {
          "imei": "015974000000301",
          "simcard_iccid": "8914800000xxxxxxxxxx"
        }
      },
      {
        "activated_timestamp": "2024-01-01T17:46:31.0Z",
        "active": true,
        "adas_camera_height": 150,
        "adas_camera_offset": 0,
        "adas_units": "imperial",
        "adas_vehicle_hood_len": 150,
        "adas_vehicle_width": 170,
        "canbus": "0",
        "channel_available": "1,2",
        "device_id": "3295982673",
        "device_type": "dv6",
        "disable_live_stream": true,
        "driver_id": null,
        "driver_name": "veritatis qui dolores",
        "firmware_status": null,
        "general_status": "driving",
        "gps_online": true,
        "group_name": "Master",
        "installed_id": 49501962,
        "last_connected_ts": "2024-01-01T17:46:31.0Z",
        "last_disconnected_ts": "2024-01-01T17:46:31.0Z",
        "last_sleep_connected_ts": "2024-01-01T17:46:31.0Z",
        "last_sleep_disconnected_ts": "2024-01-01T17:46:31.0Z",
        "no_sd_card": null,
        "online": true,
        "pending_company_profile": "Default",
        "serial_number": "015974000000301",
        "sleep": 0,
        "tag_plate": "ABC123",
        "timezone": "\"US/Eastern\"",
        "uploaded_company_profile": "Default",
        "vehicle_icon": "van",
        "vehicle_name": "Truck 1",
        "vin_number": "JT2BG22K3Y0485107",
        "channel_status": [
          {
            "channel": 1,
            "check_type": "live",
            "fail_snapshot_link": "https://murky-fender.net",
            "fail_status": "solid",
            "fail_ts": "1960-04-22T23:36:41.594Z",
            "success_ts": "1978-09-11T07:22:42.703Z"
          }
        ],
        "firmware_version": {
          "firmware": "ut dolore reprehenderit ad veniam",
          "gps": "ex",
          "mcu": null,
          "mcu_pending": "ipsum",
          "pdc": "ex ut",
          "pdc_pending": null,
          "uboot": null,
          "uboot_pending": "qui reprehenderit ad anim Duis"
        },
        "ignition": {},
        "latest_hdderror": {
          "count": 0,
          "first_ts": "2024-01-01T17:32:41.0Z",
          "last_ts": "2024-01-01T17:32:41.0Z"
        },
        "live_stream": {
          "duration_month": -35906803,
          "live_stream_access": true
        },
        "modem": {
          "imei": "015974000000301",
          "simcard_iccid": "8914800000xxxxxxxxxx"
        }
      },
      {
        "activated_timestamp": "2024-01-01T17:46:31.0Z",
        "active": true,
        "adas_camera_height": 150,
        "adas_camera_offset": 0,
        "adas_units": "imperial",
        "adas_vehicle_hood_len": 150,
        "adas_vehicle_width": 170,
        "canbus": "0",
        "channel_available": "1,2",
        "device_id": "3295982673",
        "device_type": "dv6",
        "disable_live_stream": true,
        "driver_id": null,
        "driver_name": "ducimus voluptates expedita",
        "firmware_status": "deserunt",
        "general_status": "driving",
        "gps_online": true,
        "group_name": "Master",
        "installed_id": -72354002,
        "last_connected_ts": "2024-01-01T17:46:31.0Z",
        "last_disconnected_ts": "2024-01-01T17:46:31.0Z",
        "last_sleep_connected_ts": "2024-01-01T17:46:31.0Z",
        "last_sleep_disconnected_ts": "2024-01-01T17:46:31.0Z",
        "no_sd_card": false,
        "online": true,
        "pending_company_profile": "Default",
        "serial_number": "015974000000301",
        "sleep": 0,
        "tag_plate": "ABC123",
        "timezone": "\"US/Eastern\"",
        "uploaded_company_profile": "Default",
        "vehicle_icon": "van",
        "vehicle_name": "Truck 1",
        "vin_number": "JT2BG22K3Y0485107",
        "channel_status": [
          {
            "channel": 1,
            "check_type": "live",
            "fail_snapshot_link": "http://dearest-keeper.net",
            "fail_status": "solid",
            "fail_ts": "1971-12-04T02:38:50.623Z",
            "success_ts": "1973-06-27T19:21:21.882Z"
          }
        ],
        "firmware_version": {
          "firmware": null,
          "gps": null,
          "mcu": null,
          "mcu_pending": "aliqua culpa",
          "pdc": "veniam",
          "pdc_pending": "pariatur",
          "uboot": "mollit",
          "uboot_pending": null
        },
        "ignition": {},
        "latest_hdderror": {
          "count": 0,
          "first_ts": "2024-01-01T17:32:41.0Z",
          "last_ts": "2024-01-01T17:32:41.0Z"
        },
        "live_stream": {
          "duration_month": 22657782,
          "live_stream_access": true
        },
        "modem": null
      }
    ]
  },
  "result": "OK"
}
🟠404Bad Company ID
🟠401Login Required
Modified at 2024-07-25 02:00:14
Previous
Get a device
Next
get device with driver id
Built with