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.

GET

/api/v1/vehicles/{vehicleId}

curl https://app.filmo.io/api/v1/vehicles/vehi_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"

Node.jsfetch('https://app.filmo.io/api/v1/vehicles/vehi_8f2a1c', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get( "https://app.filmo.io/api/v1/vehicles/vehi_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY" } )

{
  "data": {
    "id": "vehicle_9f3a2b",
    "name": "Example vehicle",
    "status": "active",
    "registrationNumber": "2026-0001",
    "seats": 1,
    "payloadKg": 1,
    "inspectionDate": "2026-09-01T08:00:00.000Z",
    "collectionId": "collection_9f3a2b",
    "collectionName": "Example collection name",
    "showInPlanner": true,
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

// No body.

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "vehicles:read"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

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.

Authorizations

Bearer API key with the scope below. vehicles:read

Headers

If-None-Matchstring

Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

vehicleIdstringRequired

Vehicle identifier.

Limits: min length 1

Response

application/json

Successful response.

Response schema: VehicleDto

Envelope: VehicleResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

Fleet vehicle. Does not include operating costs or pricing settings.

Show child attributes

data.idstring

Unique vehicle identifier.

data.namestring

Vehicle name.

data.statusstring

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

Available options: active, maintenance, inactive

data.registrationNumberstring | null

Registration number; null if not recorded.

data.seatsnumber | null

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

data.payloadKgnumber | null

Payload in kilograms; null if not recorded.

data.inspectionDatestring<date-time> | null

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

data.collectionIdstring | null

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

data.collectionNamestring | null

Collection path; null if not applicable.

data.showInPlannerboolean

true if it appears in the planner of the account.

data.createdAtstring<date-time> | null

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

data.updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
404	`not_found`	It does not exist or is outside the scope of the API key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Operations
Vehicle
Fleet vehicle.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Response

Errors

Deprecation

Related

Related pages

Vehicle