How to get Year Model for a Brand

Get the list of model years, and the models available in each year, for a brand at the provided dealer.

Use this after How to get BrandYear for a Dealer: pick a brand from that response, then call this endpoint to get its models year by year.

info

Year and model data does not change. New years and models are only ever added. Partners should store this data on their side and avoid calling this endpoint frequently.

For errors that this endpoint can return, see Get YearModel for brand — Errors.

Request

HTTP request

POST  https://api.mykaarma.com/appointment/v2/dealer-vehicle-config/year-model

Authorization

This request requires the following authorization scopes:

Scope	Level	Description
dealer.vehicle.config.read	Dealer	Authorises client to read vehicle config for the provided dealer

Request Body

Property Name	Value	Description	Required
dealerUUIDList	List<String>	List of dealer UUIDs. Only the first UUID in the list is used.	Yes
brandUuid	String	UUID of the brand, as returned by the BrandYear endpoint.	Yes, unless brandId is provided
brandId	Long	Deprecated. Numeric brand ID. Use brandUuid instead. Used only when brandUuid is not provided.	No

Sample Request Model

{
  "dealerUUIDList": [
    "string"
  ],
  "brandUuid": "string"
}

Sample Curl

curl --location 'https://api.mykaarma.com/appointment/v2/dealer-vehicle-config/year-model' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{basic_auth_token}}' \
--data '{
  "dealerUUIDList": [
    "string"
  ],
  "brandUuid": "string"
}'

Response

yearModels is sorted by year, newest first. Within each year, model names are sorted alphabetically. If no vehicle configuration is found for the brand, yearModels is null.

If the dealer is set up to exclude powersports models, motorcycles, ATVs and utility vehicles are left out of the results.

Property Name	Value	Description
yearModels	List<YearModel>	One entry per model year
yearModels[].year	String	Model year, for example "2025"
yearModels[].model	List<String>	Model names available for that year
statusCode	Integer	Set to 400 when the request fails validation
error	ApiError	Error details, if the request failed

Sample Response

{
  "yearModels": [
    {
      "year": "2025",
      "model": [
        "string",
        "string"
      ]
    },
    {
      "year": "2024",
      "model": [
        "string"
      ]
    }
  ],
  "statusCode": null,
  "error": null
}