Skip to content

List vehicle categories

GET
/v1/reference/vehicle-categories
curl --request GET \
--url https://api2.recruso.co.uk/v1/reference/vehicle-categories \
--header 'Authorization: <Authorization>'

Returns every vehicle category the platform publishes. The DVLA licence categories a driver can hold.

These values are platform-wide: every agency sees the same list and the same ids, and your agency cannot add to them or change them. No endpoint published on this API takes a vehicle category id yet; the vocabulary is published so that its values are enumerable.

The list is not paged, and no order is guaranteed — sort client-side if you need one. The values change very rarely, so cache them rather than fetching them before every call.

Access. Requires an authenticated token. No further policy is applied.

OK

Media typeapplication/json

Every vehicle category the platform publishes.

object
vehicleCategories
required

The vehicle categories. Never null.

Array<object>

One vehicle category in a list.

object
id

The vehicle category’s identifier. Stable and platform-wide — the same id means the same thing for every agency.

integer format: int16
name

The vehicle category name, as it appears in Recruso. Up to 10 characters. Unique across all vehicle categories.

string
description

A longer description of the vehicle category. May be null.

string
nullable
Example
{
"vehicleCategories": [
{
"id": 1,
"name": "A",
"description": "Motorcycle"
}
]
}

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}