Skip to main content
GET
/
vehicle
curl
curl --request GET \
  --url 'https://api.amps.ai/vehicle' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "device_vehicle_001",
        "vendor": "example_vendor_a",
        "sync": {
          "available": true,
          "lastPulledAt": "2026-05-07T09:23:45.000Z"
        },
        "metadata": {
          "model": "EV Sedan",
          "source": "live"
        },
        "state": {
          "batteryLevel": 64,
          "range": 184,
          "plugged": true,
          "charging": true,
          "fullyCharged": false,
          "batteryCapacity": 75,
          "chargeLimit": 80,
          "chargeRate": 7,
          "chargeTimeRemaining": 110,
          "maxCurrent": 32
        }
      },
      {
        "id": "device_vehicle_002",
        "vendor": "example_vendor_b",
        "sync": {
          "available": true,
          "lastPulledAt": "2026-05-07T09:24:10.000Z"
        },
        "metadata": {
          "model": "EV SUV",
          "source": "cache"
        },
        "state": {
          "batteryLevel": 88,
          "range": 296,
          "plugged": false,
          "charging": false,
          "fullyCharged": false,
          "batteryCapacity": 100,
          "chargeLimit": 90,
          "chargeRate": 0,
          "chargeTimeRemaining": 0,
          "maxCurrent": 32
        }
      }
    ],
    "pagination": {
      "limit": 10,
      "offset": 0,
      "total": 2,
      "hasMore": false
    }
  },
  "meta": {
    "requestId": "req_8a2Bf3kP",
    "environment": "sandbox",
    "timestamp": "2026-06-02T12:00:00.000Z",
    "latencyMs": 12
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
userId
string

Filter devices by userId

Example:

"user_abc123"

​
offset
number

Number of devices to skip (default: 0)

Example:

0

​
limit
number

Maximum number of devices to return (1-50, default: 10)

Example:

10

Response

Vehicle devices retrieved successfully

​
success
boolean
required

Always true for success responses.

​
data
Paginated Vehicle · object
required
​
meta
Response Meta · object
required

Metadata attached to every response: the request identifier, the serving environment, the build timestamp, and the server-side latency.