RoscoLive API v1.0(v2.37.0)
  1. Company
RoscoLive API v1.0(v2.37.0)
  • Company
    • Create a company
      PUT
    • Get a company by ID
      GET
    • Update company
      POST
    • Get a company
      GET
    • Get companies
      GET
  • Device
    • Geotab
      • Get device by geotab device serial number
    • Update a device settings
      POST
    • Get reported DTCs for devices
      GET
    • Get company devices
      GET
    • Search devices
      GET
    • Play in-cab audible alert sound for device
      POST
    • Get list of trip dates for device
      GET
    • Get list of trips for passed device and date
      GET
    • Get a device
      GET
    • Get devices for all companies available for user
      GET
    • Get available video list for date
      GET
    • Get device list for multiple companies
      GET
  • Driver Scoring / Coaching
    • Get driver scores
      GET
    • Get unknown driver trips
      GET
  • Event
    • Request Custom Event
      PUT
    • Get Company Events
      GET
    • Send an event
      PUT
    • Get snapshot/location of event
      GET
    • Get Device Events for Period
      GET
    • Request custom video from device
      PUT
    • Get event filters list for date range in company
      GET
  • Group
    • Get devices of a group
  • Metadata
    • Get metadata of a device
    • Get metadata of devices
    • Get alerts of a driver
  1. Company

Get a company

GET
/partners/companies/{company_name}
Returns a single company object.

User Role Permissions#

The following table shows which user roles are allowed to send requests using this API endpoint.
RolePermission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Path Params

Query Params

Responses

🟢200Return company
application/json
Body

🟠404Record not found
🟠404Resource Not Found
🔴500Internal Server Error
🟠401Login Required
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/partners/companies/Acme Trucking?byid=company'
Response Response Example
200 - Success
{
    "meta": {
        "code": 200
    },
    "response": {
        "company": {
            "active": true,
            "advanced_profile_settings": true,
            "billing_date": 1,
            "company_address": "853 Russel Throughway",
            "company_address2": "9614",
            "company_city": "Handshire",
            "company_country": "Serbia",
            "company_key": "A1B2C3D4E5",
            "company_metadata": null,
            "company_name": "Murazik, Ullrich and Bednar",
            "company_phone_number": "817.234.5586 x460",
            "company_country_code": null,
            "company_state": "Kentucky",
            "company_type": "CUSTOMER",
            "company_zipcode": "24349-1541",
            "created_by": 9,
            "created_by_company_id": 86,
            "custom_apn": "http://realistic-acrylic.org",
            "data_limit": 3,
            "data_usage_threshold": 92336197,
            "driver_recognition": "manual",
            "event_expiration": "365",
            "geotab_database": "rosco",
            "geotab_email": "Tillman.Rice49@hotmail.com",
            "geotab_path": "http://quizzical-lyrics.org",
            "hash": "dolore est labore",
            "id": 2,
            "live_active": true,
            "owner_company": "Rosco Vision Partner",
            "partner_company": "Rosco Vision Partner",
            "reformat_reminder": 6,
            "speedlimit_audio": true,
            "speedlimit_feature": true,
            "status": "used",
            "storage_active": true,
            "token": "12345678",
            "trace_active": true,
            "trial_status": true,
            "trial_subscribers": "example1@email.com,example2@email.com"
        }
    },
    "result": "OK"
}
Modified at 2025-10-08 17:06:46
Previous
Update company
Next
Get companies
Built with