Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • eq(id,xxx): Filter vehicles by ID.
  • eq(organisation,xxx): Filter vehicles by organisation ID.
  • eq(registration,xxx): Filter vehicles by registration number.
  • contains(registration,xxx): Filter vehicles where registration contains value.
  • eq(specification,xxx): Filter vehicles by specification ID.
  • eq(team,xxx): Filter vehicles by team ID.
  • eq(assignee,xxx): Filter vehicles by assignee user ID.
  • eq(status,xxx): Filter vehicles by status.

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
assignee,
equipment,
organisation,
specification,
team,
categories,
certifications
limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of vehicles.

JSON API response object

data
A list of vehicles · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a vehicle is returned.

An equipment item