Model groups

Vehicle model groups describe a group of a vehicle model.

Model group

Vehicle model group.

id
integer <int64>

Vehicle model group identifier.

enabled
boolean

Whether the vehicle model group is enabled.

make_id
integer

Vehicle make identifier.

name
string [ 1 .. 255 ] characters

Name of vehicle model group.

{
  • "id": 5796,
  • "enabled": true,
  • "make_id": 49,
  • "name": "FOCUS"
}

Retrieve vehicle model groups

Retrieve a list of vehicle model groups.

SecurityOAuth2
Request
query Parameters
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

make_id
integer <int64>

Filter vehicle model groups by make identifier.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Model group) >= 0 items

List of model groups.

Array (>= 0 items)
id
integer <int64>

Vehicle model group identifier.

enabled
boolean

Whether the vehicle model group is enabled.

make_id
integer

Vehicle make identifier.

name
string [ 1 .. 255 ] characters

Name of vehicle model group.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/vehicles/model-groups
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve vehicle model group

Retrieve a single vehicle model group by its identifier.

SecurityOAuth2
Request
path Parameters
model-group-id
required
integer <int64>

Vehicle model group identifier.

Responses
200

Successful response.

Response Schema: application/json
id
integer <int64>

Vehicle model group identifier.

enabled
boolean

Whether the vehicle model group is enabled.

make_id
integer

Vehicle make identifier.

name
string [ 1 .. 255 ] characters

Name of vehicle model group.

default

An error occurred - see status code and problem response for more information.

get/v2/vehicles/model-groups/{model-group-id}
Response samples
application/json
{
  • "id": 5796,
  • "enabled": true,
  • "make_id": 49,
  • "name": "FOCUS"
}