RoscoLive API v1.0
  • Company
  • Device
    • Get a deviceGET
    • get list of company devicesGET
  • Device Firmware
  • Driver Scoring / Coaching
  • Event
  • Live streaming
  • Report
  • User
logoPowered by Apidog
  1. Device

get list of company devices

GET/companies/{company_id}/devices/list

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

Responses

get list of company devices(200)
Bad Company ID(404)
get list of company devices
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
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"
}
Last modified: 6 months ago