Vehicles
Get a vehicle
Returns a vehicle by its identifier: license plate, seats, payload, next inspection date, collection and whether it appears in the planner.
vehicles:readvehicles:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
It does NOT include the cost per kilometer: crossed with the duration of a service it gives what moving the equipment costs the company, and internal costs are excluded from the public edge by design.
Arguments
Vehicle identifier.
Limits: min length 1
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/{vehicleId}.
Related pages
Link to this section: Related pagesVehicles
Get a vehicle
Returns a vehicle by its identifier: license plate, seats, payload, next inspection date, collection and whether it appears in the planner.
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?