RoscoLive API v1.0
  1. Company
RoscoLive API v1.0
  • Company
    • create a company
      PUT
    • get a company by ID
      GET
    • update company
      POST
    • get a company
      GET
    • get companies
      GET
    • get partner companies list
      GET
    • get own partner company
      GET
  • Device
    • Get a device
      GET
    • get list of company devices
      GET
  • Device Firmware
    • get available firmware versions
      GET
    • get list of latest firmware versions
      GET
    • push firmware to device
      POST
    • cancel pending firmware update to devices
      DELETE
    • get firmware updates history for company
      GET
  • Driver Scoring / Coaching
    • get company drivers list
      GET
    • add a driver
      PUT
  • Event
    • Get company events
      GET
    • Request videos of an event
      PUT
    • get a last event of devices
      GET
    • get geotab events
      GET
    • get a last updated event of devices
      GET
    • update an event
      POST
  • Live streaming
    • start live streaming
      GET
  • Report
    • get list of companies with data usage for date range
  • User
    • Update notification by email
    • Get event / sms notification settings
  1. Company

get companies

GET
/partners/companies
partnercompany
Returns a list of company objects for all companies associated with the partner.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://fleet.roscolive.com/api/v1.0/partners/companies?company_type=CUSTOMER'
Response Response Example
200 - 200
{
    "meta": {
        "code": 200
    },
    "response": {
        "companies": [
            {
                "active": true,
                "advanced_profile_settings": true,
                "asset_deletion_protection": false,
                "billing_date": 1,
                "company_address": "address",
                "company_address2": "address2",
                "company_city": "Castle",
                "company_country": "USA",
                "company_key": "f718695b37",
                "company_name": "Rosco Vision",
                "company_phone_number": "",
                "company_state": "Main",
                "company_type": "CUSTOMER",
                "company_zipcode": "98786",
                "created_by": 17,
                "created_by_company_id": 3,
                "custom_apn": "",
                "cutoff_when_overage": false,
                "data_limit": 3,
                "data_usage_threshold": 1024.0,
                "driver_recognition": "manual",
                "event_expiration": "365",
                "geotab_database": "",
                "geotab_email": "sdfsdf@sadasd.ru",
                "geotab_path": "",
                "hash": "c2c7a460f0f4b812003569eafc6bb9ed",
                "id": 2,
                "live_active": true,
                "owner_company": "Rosco Vision Partner",
                "partner_company": "Rosco Vision Partner",
                "reformat_reminder": 5,
                "status": "used",
                "storage_active": true,
                "token": "12345678",
                "trace_active": true,
                "trial_status": false,
                "trial_subscribers": ""
            },
    },
}

Request

Query Params
company_type
enum<string> 
optional
Will return the companies that match the passed in type. If no type provided, will return all companies of all types available to user.
Allowed values:
PARTNERCOMPANY
Example:
CUSTOMER
Body Params multipart/form-data
object {0}

Responses

🟢200Return Companies List
application/json
Body
meta
object 
required
Request metadata object
code
integer 
required
HTTP status code returned by server
response
object 
required
Contains response data
companies
array[object (Company) {37}] 
required
List of companies
result
string 
required
"OK" if request successful, otherwise "Fail"
🟠404Resource Not Found
🔴500Internal Server Error
🟠401Login Required
Modified at 2024-11-26 18:38:04
Previous
get a company
Next
get partner companies list
Built with