Get Model Variant by slug

GET

/api/v1/model_variants/{slug}

curl --request GET \
  --url 'https://dashboard.dealerstudio.com.au/api/v1/model_variants/example?website_id=example' \
  --header 'Authorization: Bearer <token>'

• Production server
• Development server

Authorizations

• Bearer

Parameters

Path Parameters

slug

required

string

Model variant slug

Query Parameters

website_id

required

string

Website ID or slug

Responses

200

Retrieves model variant with specifications and price

Media type application/json

object

id

required

integer

slug

required

string

model_id

integer

name

required

string

bodyStyle

string

nullable

transmission

string

nullable

modelCode

string

nullable

engine_capacity

string

nullable

isHybrid

boolean

nullable

isElectric

boolean

nullable

cylinders

integer

nullable

year

integer

nullable

fuel

string

nullable

redbookCode

string

nullable

series

string

nullable

variant_category

string

nullable

tare_weight

integer

nullable

seats

integer

nullable

vehicle_category

string

nullable

description

string

nullable

short_description

string

nullable

youtube_id

string

nullable

full_name

required

string

image

object

url

string

nullable

thumb

object

url

string

nullable

price

integer

nullable

specifications

required

Array<object>

object

category

object

id

integer

name

string

slug

string

position

integer

fields

Array<object>

object

id

integer

name

string

slug

string

position

integer

value

string

Example ^generated

{
  "id": 1,
  "slug": "example",
  "model_id": 1,
  "name": "example",
  "bodyStyle": "example",
  "transmission": "example",
  "modelCode": "example",
  "engine_capacity": "example",
  "isHybrid": true,
  "isElectric": true,
  "cylinders": 1,
  "year": 1,
  "fuel": "example",
  "redbookCode": "example",
  "series": "example",
  "variant_category": "example",
  "tare_weight": 1,
  "seats": 1,
  "vehicle_category": "example",
  "description": "example",
  "short_description": "example",
  "youtube_id": "example",
  "full_name": "example",
  "image": {
    "url": "example",
    "thumb": {
      "url": "example"
    }
  },
  "price": 1,
  "specifications": [
    {
      "category": {
        "id": 1,
        "name": "example",
        "slug": "example",
        "position": 1
      },
      "fields": [
        {
          "id": 1,
          "name": "example",
          "slug": "example",
          "position": 1,
          "value": "example"
        }
      ]
    }
  ]
}

401

Unauthorized - Missing show:model_variant permission

403

Forbidden - API key not authorised for this website

404

Model variant not found