Skip to main content
GET
/
vehicles
/
{vehicleId}
/
signals
List signals
curl --request GET \
  --url https://vehicle.api.smartcar.com/v3/vehicles/{vehicleId}/signals \
  --header 'Authorization: Bearer <token>' \
  --header 'sc-user-id: <sc-user-id>'
{
  "data": [
    {
      "id": "<string>",
      "type": "signal",
      "attributes": {
        "code": "charge-voltage",
        "name": "Voltage",
        "group": "Charge",
        "status": {
          "value": "SUCCESS"
        },
        "body": {
          "unit": "volts",
          "value": 85
        }
      },
      "meta": {
        "retrievedAt": "2023-10-01T20:00:00Z",
        "oemUpdatedAt": "2023-10-01T19:59:59Z",
        "ingestedAt": "2023-10-01T20:01:00Z"
      },
      "links": {
        "self": "<string>",
        "values": "<string>",
        "vehicle": "<string>"
      }
    }
  ],
  "meta": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 5
  },
  "links": {
    "self": "/vehicles/vehicle123/signals?page=1&pageSize=10",
    "first": "/vehicles/vehicle123/signals?page=1&pageSize=10",
    "prev": null,
    "next": "/vehicles/vehicle123/signals?page=2&pageSize=10",
    "last": "/vehicles/vehicle123/signals?page=5&pageSize=10"
  },
  "included": {
    "vehicle": {
      "id": "<string>",
      "type": "vehicle",
      "attributes": {
        "make": "<string>",
        "model": "<string>",
        "year": 123,
        "powertrainType": "<string>",
        "mode": "live"
      },
      "links": {
        "self": "<string>"
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

The Authorization header must be provided with a valid bearer token. Example: Authorization: Bearer {token}

Headers

​
sc-user-id
string
required

The identifier of the vehicle user on whose behalf the command is being executed. Vehicle commands require both the vehicleId (path) and sc-user-id (header) to identify the specific vehicle and the user who has granted permission to act on it. The bearer token is a machine-to-machine token and does not carry per-user context, so this header must be provided explicitly for every command request.

Path Parameters

​
vehicleId
string
required

The unique identifier for the vehicle.

Response

List of signals for the vehicle

​
data
object[]
​
meta
object
Example:
{
  "pageNumber": 1,
  "pageSize": 10,
  "totalCount": 5
}
​
links
object
Example:
{
  "self": "/vehicles/vehicle123/signals?page=1&pageSize=10",
  "first": "/vehicles/vehicle123/signals?page=1&pageSize=10",
  "prev": null,
  "next": "/vehicles/vehicle123/signals?page=2&pageSize=10",
  "last": "/vehicles/vehicle123/signals?page=5&pageSize=10"
}
​
included
object