GET
/
vehicles
/
{id}
/
diagnostics
/
system_status
curl "https://api.smartcar.com/v2.0/vehicles/{id}/diagnostics/system_status" \\
    -H "Authorization: Bearer {token}" \\
    -X "GET"
{
      "systems": [
          {
              // System ID from Smartcar unified system definition list
              "systemId": "SYSTEM_TPMS",
              "status": "ALERT",
              "description": "Left rear tire sensor battery low"
          },
          {
              "systemId": "SYSTEM_AIRBAG",
              "status": "OK",
              "description": null
          },
          {
              "systemId": "SYSTEM_MIL",
              "status": "OK",
              "description": null
          },
          ...
      ]
}

Permission

read_diagnostics

curl "https://api.smartcar.com/v2.0/vehicles/{id}/diagnostics/system_status" \\
    -H "Authorization: Bearer {token}" \\
    -X "GET"

Request

Path

id
string
required

The vehicle ID of the vehicle you are making a request to.

Response

systems
array

An overview of systems reported by the vehicle.

systemID
string

The unique identifier of a system reported by the vehicle.

status
string

The status of a vehicle, expected as “OK” or “ALERT”.

description
string | null

A plain-text description of the status, if available.

{
      "systems": [
          {
              // System ID from Smartcar unified system definition list
              "systemId": "SYSTEM_TPMS",
              "status": "ALERT",
              "description": "Left rear tire sensor battery low"
          },
          {
              "systemId": "SYSTEM_AIRBAG",
              "status": "OK",
              "description": null
          },
          {
              "systemId": "SYSTEM_MIL",
              "status": "OK",
              "description": null
          },
          ...
      ]
}

Was this page helpful?