Vehicles

List vehicles

Returns the fleet used to deliver and pick up the material: operational status, license plate, seats and payload.

Tool
filmo_vehicles_list
Access: Read

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_vehicles_list",
    "arguments": {
      "limit": 20
    }
  }
}

generated from the schema

It emits no operating costs or pricing configuration. Sorted by name.

Arguments

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

qstring

Free-text search on the name and the registration number.

Limits: min length 1, max length 200

sortstring

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

statusstring

Filter by vehicle status: active, maintenance or inactive.

Available options: active, maintenance, inactive

statusesstring[]

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

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

dateFiltersobject

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 attributes
dateFilters.createdobject

Show child attributes
dateFilters.created.gtestring

From this day or instant, inclusive.

dateFilters.created.ltestring

Up to this day or instant, inclusive.

dateFilters.created.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.created.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.created.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.inspectionobject

Show child attributes
dateFilters.inspection.gtestring

From this day or instant, inclusive.

dateFilters.inspection.ltestring

Up to this day or instant, inclusive.

dateFilters.inspection.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.inspection.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.inspection.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.updatedobject

Show child attributes
dateFilters.updated.gtestring

From this day or instant, inclusive.

dateFilters.updated.ltestring

Up to this day or instant, inclusive.

dateFilters.updated.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.updated.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.updated.onstring

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
idstring

Unique vehicle identifier.

namestring

Vehicle name.

statusstring

Operational status: active (available), maintenance (in the workshop) or inactive (out of service).

Available options: active, maintenance, inactive

registrationNumberstring | null

Registration number; null if not recorded.

seatsnumber | null

Seats, including the driver seat; null if not recorded.

payloadKgnumber | null

Payload in kilograms; null if not recorded.

inspectionDatestring<date-time> | null

Date of the next technical inspection in ISO 8601 UTC; null if not recorded.

collectionIdstring | null

Identifier of the collection it belongs to; null if it is in none.

collectionNamestring | null

Collection path; null if not applicable.

showInPlannerboolean

true if it appears in the planner of the account.

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

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].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/vehicles.

  • Vehicles

    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: true and the problem in the first text block. Branch on its code.