Get Vehicles

Description

Retrieves a list of vehicles owned by the user that have agreed to share vehicle data.

Endpoint

GET https://api.pleos.ai/v1/vehicles

Request

curl

curl -X GET "https://api.pleos.ai/v1/vehicles/consent" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -H "Brand: hyundai" \

Header Params

Parameter	Type	Description	Required
Authorization	string	Access token	Optional
Brand	string	Vehicle brand (hyundai/kia/genesis)	Required

Responses

Success

200

{
  "data": {
    "vehicles": [
      {
        "vin": "TEST111111111TEST",
        "nickname": "My Car",
        "name": "UM(UM)",
        "type": "GN",
        "sellname": "Sorento"
      }
    ]
  },
  "meta": {
    "code": 200,
    "message": "Success",
    "success": "true",
    "timestamp": "2025-09-01T11:00:00Z",
    "requestId": "835bdbd4-1105-4a8c-b438-a1b2c3d4f5g6"
  }
}

data field	Type	Description
vehicles	array	List of vehicles
└─ vin	string	Vehicle Identification Number (17 characters)
└─ type	string	Vehicle type - GN: Internal combustion engine - EV: Electric vehicle - HV: Hybrid - PE: Plug-in hybrid - FV: Hydrogen fuel cell - UNKNOWN
└─ nickname	string	Nickname set by the user in the app
└─ name	string	Model name (model code)
└─ sellname	string	Sales model name of the vehicle

Failure

4002

{
  "error": {
    "code": "4002",
    "message": "Invalid request parameters",
    "details": [],
    "timestamp": "2025-09-01T12:00:00Z",
    "requestId": "835bdbd4-1105-4a8c-b438-a1b2c3d4f5g6"
  }
}

[Error Code]

For a detailed explanation of error codes that occur upon failure, refer to Error Code.