get partner companies list

GET

/partner/companies/list

partnercompanylist

Returns a list of company objects related to the current user's partner with select data.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://fleet.roscolive.com/api/v1.0/partner/companies/list?include_data'

Response Example

200 - Success

{
    "meta": {
        "code": 200
    },
    "response": {
        "companies": [
            {
                "company_key": "f718695b37",
                "company_name": "Turcotte - Hoppe",
                "data_usage": null,
                "devices_count": 230,
                "id": 1234,
                "live_active": false,
                "profile_name": "Default",
                "trial_date": null,
                "trial_status": false
            },
            {
                "company_key": "f718695b37",
                "company_name": "Ryan and Sons",
                "data_usage": {
                    "available_data_pool": 235520,
                    "total_data_usage": 1897
                },
                "devices_count": 230,
                "id": 1234,
                "live_active": false,
                "profile_name": "Default",
                "trial_date": "2024-01-01 17:31:42",
                "trial_status": true
            },
            {
                "company_key": "f718695b37",
                "company_name": "Bergstrom Inc",
                "data_usage": {
                    "available_data_pool": 235520,
                    "total_data_usage": 1897
                },
                "devices_count": 230,
                "id": 1234,
                "live_active": false,
                "profile_name": "Default",
                "trial_date": null,
                "trial_status": false
            }
        ]
    },
    "result": "OK"
}

Request

Query Params

include_data

string

optional

A comma-separated list of column names to include in the returned data. Possible values: data_usage

Responses

🟢200Success

application/json

Body