External API
Docs & Playground
Vehicles/get_unit_general_info

get_unit_general_infotoken required

Returns one row of general info for a single vehicle/unit — identity, client & group, manufacturer/model, latest state, and service/config fields.

Try in playground
POST/api— body field action.name = "get_unit_general_info"

Parameters

NameTypeRequiredDescription
vehicle_idnumberoptionalVehicle id. The resolver tries vehicle_id → inner_id → license_nmbr → vin in that order; supply at least one of the four.e.g. 591723
inner_idstringoptionalUnit inner id (alternative identifier).e.g. 0000000905516028
license_nmbrstringoptionalLicense plate / number.e.g. 17108
vinstringoptionalVehicle VIN.e.g. 3HBBZMMN9VL211016

Notes

Supply at least one identifier (action_value '1' if none provided). action_value '2' = user not allowed / no such vehicle; '3' = more than one vehicle matched (also pass vehicle_id or inner_id to disambiguate); '999' = internal error. `fuel_used` is the device's cumulative fuel counter, read from the unit header. `configuration_status` / `configuration_description` (Mexico): whether the unit has a firmware or settings update that has not finished, as the legacy platform reports it — `0` with `OK` when none; `1` with `FW ,<state> ,<progress>%` while the newest firmware job has not finished; `2` with `SB ,<state> ,0% ` while the newest settings job is not Configured. The description is URL-encoded and refreshes hourly. Other regions return both empty. `last_communication_time` / `last_location_time` can lag while telemetry catches up. `vcl_client_owner` is the client directly above `vcl_client_id` in the client tree (legacy `OWNER`), empty for a top-level client.

Request

curl
curl -X POST 'https://private.develop-1.questar.io/v2/private-questar-units/api' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  --data '{"action":{"name":"get_unit_general_info","parameters":[{"vehicle_id":591723,"inner_id":"0000000905516028","license_nmbr":"17108","vin":"3HBBZMMN9VL211016"}]}}'
Body
{
  "action": {
    "name": "get_unit_general_info",
    "parameters": [
      {
        "vehicle_id": 591723,
        "inner_id": "0000000905516028",
        "license_nmbr": "17108",
        "vin": "3HBBZMMN9VL211016"
      }
    ]
  }
}

Response

Successful responses always wrap the action's payload in response.properties. The action_value field reports the handler outcome: "0" for success, "1" for invalid params, "2" for not allowed, "3" for limit-exceeded /pagination-session-expired, "999" for general error.

Authentication is checked before the action runs and fails the same way for every action. A token that is not valid returns HTTP 200 with action_value "2" and description invalid_session; an empty bearer returns "2" with session_token_required. Read the description to tell these apart from an action's own "2". With no Authorization header the gateway answers HTTP 401 {"message":"Unauthorized"}, and with a bearer that is not a token HTTP 403 {"message":"Forbidden"}.

200 OK
{
  "response": {
    "properties": {
      "action_name": "get_unit_general_info",
      "action_value": "0",
      "description": "success",
      "data": [
        {
          "inner_id": "0000000905516028",
          "vehicle_id": "591723",
          "license_nmbr": "17108",
          "vin": "3HBBZMMN9VL211016",
          "ignition": "1",
          "Vcl_manufacturer": "International",
          "Vcl_model": "Interbus-B6.7 200-EPA24-M-CNT",
          "vcl_client_id": "14953",
          "vcl_client_description": "LIPU L CARDENAS",
          "vcl_client_group_id": "39201",
          "vcl_client_group_description": "FERTINAL (DINAMICA DEL BALSAS)",
          "firmware_version": "",
          "last_communication_time": "2025-09-10T12:00:00",
          "last_location_time": "2025-09-10T11:58:00",
          "driver_code": "",
          "mileage": "13210.05",
          "fuel_used": "",
          "speed": "0",
          "engine_hours": "1234.5",
          "configuration_status": "2",
          "configuration_description": "SB%20%2CIn%20Process%20%2C0%25%20",
          "vcl_manufacturer": "Volvo",
          "vcl_model": "FH16",
          "vcl_client_owner": "14929"
        }
      ]
    }
  }
}