Skip to main content
GET
/
subscriptions
List subscriptions
curl --request GET \
  --url https://management.api.smartcar.com/v3/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "subscription",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "vehicle": {
          "make": "TESLA",
          "model": "Model 3",
          "year": 2023,
          "mode": "live",
          "powertrainType": "BEV"
        }
      },
      "meta": {
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "webhook": {
          "data": {
            "type": "webhook",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "links": {
            "related": "<string>"
          }
        },
        "user": {
          "data": {
            "type": "webhook",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "links": {
            "related": "<string>"
          }
        },
        "vehicle": {
          "data": {
            "type": "webhook",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "links": {
            "related": "<string>"
          }
        }
      },
      "links": {
        "self": "<string>"
      }
    }
  ],
  "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"
  },
  "meta": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 50
  }
}

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<uuid>

Filter subscriptions by user ID

​
filter[webhookId]
string<uuid>

Filter subscriptions by webhook ID

​
filter[vehicleId]
string<uuid>

Filter subscriptions by vehicle ID

​
filter[vehicle.mode]
enum<string>

The mode of the vehicle (live or simulated)

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

Page number for pagination (JSON:API)

Required range: x >= 1
​
page[size]
integer
default:25

Number of resources per page (JSON:API)

Required range: 1 <= x <= 100

Response

Get subscription details

​
data
object[]
required
​
links
object
required
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"
}
​
meta
object
required
Example:
{
  "pageNumber": 1,
  "pageSize": 10,
  "totalCount": 50
}