Vehicles
List vehicles
Returns the fleet used to deliver and pick up the material: operational status, license plate, seats and payload.
vehicles:readvehicles:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
It emits no operating costs or pricing configuration. Sorted by name.
Arguments
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
Free-text search on the name and the registration number.
Limits: min length 1, max length 200
Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, name, registrationNumber, status, seats, payloadKg. Defaults to "name". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.
Limits: max length 200
Filter by vehicle status: active, maintenance or inactive.
Available options: active, maintenance, inactive
Filter by status, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Available options: active, maintenance, inactive
Limits: min 1 items, max 50 items
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, inspection, updated.
Show child attributesHide child attributes
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique vehicle identifier.
Vehicle name.
Operational status: active (available), maintenance (in the workshop) or inactive (out of service).
Available options: active, maintenance, inactive
Registration number; null if not recorded.
Seats, including the driver seat; null if not recorded.
Payload in kilograms; null if not recorded.
Date of the next technical inspection in ISO 8601 UTC; null if not recorded.
Identifier of the collection it belongs to; null if it is in none.
Collection path; null if not applicable.
true if it appears in the planner of the account.
Creation date in ISO 8601 UTC; null if not recorded.
Last modification date in ISO 8601 UTC; null if not recorded.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs GET /api/v1/vehicles.
Related pages
Link to this section: Related pagesVehicles
List vehicles
Returns the fleet used to deliver and pick up the material: operational status, license plate, seats and payload.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?