RoscoLive API v1.0

get companies

GET/partners/companies

Returns a list of company objects for all companies associated with the partner.

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

Request samples

Responses

Return Companies List(200)

Return Companies List

HTTP Code: 200

Content Type : JSONapplication/json

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"

{
    "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": ""
            },
    },
}

Last modified: 2 months ago