get a company by ID

GET

/partners/companies/{company_id}

company

Return data for company of the passed in company_id

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://fleet.roscolive.com/api/v1.0/partners/companies/123456?byid=company&include_data=data_usage' \
--header 'Content-Type: text/plain' \
--data-raw ''

Response Example

200 - Success

{
    "meta": {
        "code": 200
    },
    "response": {
        "company": {
            "billing_date": 1,
            "company_address": "5585 Nikolaus Point",
            "company_address2": "50574",
            "company_city": "Fort Lue",
            "company_country": "Slovakia (Slovak Republic)",
            "company_key": "A1B2C3D4E5",
            "company_metadata": null,
            "company_name": "Bahringer - McGlynn",
            "company_phone_number": "580.452.3709",
            "company_country_code": null,
            "company_state": "Connecticut",
            "company_type": "PARTNER",
            "company_zipcode": "67014",
            "created_by": 8,
            "created_by_company_id": 1,
            "custom_apn": "http://common-guarantee.net",
            "data_usage_threshold": 47247196,
            "data_usage": null,
            "driver_recognition": "manual",
            "event_expiration": "365",
            "geotab_database": "rosco",
            "geotab_email": "Melyna_Runolfsson53@gmail.com",
            "geotab_path": "https://webbed-eddy.net",
            "hash": "ipsum Duis qui nulla nisi",
            "id": 2,
            "industry_type": "Waste Management",
            "live_active": true,
            "owner_company": "Rosco Vision Partner",
            "partner_company": "Rosco Vision Partner",
            "reformat_reminder": 6,
            "status": "used",
            "storage_active": true,
            "token": "12345678",
            "trace_active": true,
            "trial_status": true,
            "trial_subscribers": "example1@email.com,example2@email.com",
            "using_rosco_sim": true
        }
    },
    "result": "OK"
}

Request

Path Params

company_id

integer

required

ID of company to retrieve data for

Example:

123456

Query Params

byid

enum<string>

required

Returns company of passed in company_id param

Allowed value:

company

Example:

company

include_data

string

optional

Comma-separated list of column data to include in response. Available values: data_usage

Example:

data_usage

Responses

🟢200Success

application/json

Body