RoscoLive API v1.0

get partner companies list

GET/partner/companies/list

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

Request

Query Params

include_data

string

optional

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

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by response

response

object

required

Contains response data

companies

array [object {9}]

required

result

string

required

"OK" if successful, else "Fail" if error

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

Last modified: 2 months ago