Skip to main content
GET
/
connections
List connections
curl --request GET \
  --url https://vehicle.api.smartcar.com/v3/connections \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "connection",
      "attributes": {
        "permissions": [
          "read_vehicle_info",
          "read_odometer"
        ],
        "vehicle": {
          "make": "Tesla",
          "model": "Model S",
          "year": 2020,
          "mode": "live",
          "powertrainType": "BEV"
        }
      },
      "relationships": {
        "vehicle": {
          "data": {
            "id": "<string>",
            "type": "vehicle"
          },
          "links": {
            "related": "<string>"
          }
        },
        "user": {
          "data": {
            "id": "<string>",
            "type": "user"
          },
          "links": {
            "related": "<string>"
          }
        }
      },
      "meta": {
        "createdAt": "2023-10-01T20:00:00Z",
        "updatedAt": "2023-10-01T20:00:00Z",
        "lastUsedAt": null
      },
      "links": {
        "self": "<string>"
      }
    }
  ],
  "meta": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 50,
    "orderBy": "createdAt",
    "orderDirection": "DESC"
  },
  "links": {
    "self": "/connections?page[number]=1&page[size]=10",
    "first": "/connections?page[number]=1&page[size]=10",
    "prev": null,
    "next": "/connections?page[number]=2&page[size]=10",
    "last": "/connections?page[number]=5&page[size]=10"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
filter[userId]
string

Filter by user id in relationships

​
filter[vehicleId]
string

Filter by vehicle id in relationships

​
filter[vehicle.mode]
enum<string>
default:live

Filter by mode (live or simulated)

Available options:
live,
simulated
​
page[number]
integer
default:1

Page number for pagination (default is 1)

​
page[size]
integer
default:10

Number of items per page for pagination (default is 10)

Response

Get all vehicle connections for the application

​
data
object[]
​
meta
object
Example:
{
  "pageNumber": 1,
  "pageSize": 10,
  "totalCount": 50,
  "orderBy": "createdAt",
  "orderDirection": "DESC"
}
​
links
object
Example:
{
  "self": "/connections?page[number]=1&page[size]=10",
  "first": "/connections?page[number]=1&page[size]=10",
  "prev": null,
  "next": "/connections?page[number]=2&page[size]=10",
  "last": "/connections?page[number]=5&page[size]=10"
}