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 vehicle inventory checks by ID.
  • eq(organisation,xxx): Filter vehicle inventory checks by organisation ID.
  • eq(vehicle,xxx): Filter vehicle inventory checks by vehicle ID.
  • eq(author,xxx): Filter vehicle inventory checks by author user ID.
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
equipment,
organisation,
vehicle
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 vehicle inventory checks.

JSON API response object

data
A list of vehicle inventory checks · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

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

An equipment item