Vehicles

Retrieve a vehicle

Returns a single vehicle by id, scoped to the authenticated user's company. Unknown ids, ids from another company, and soft-deleted rows all return 404 — never 403, never 200 with deleted_at populated.

get/v1/vehicles/{id}

Request

  • Base URL: https://api.officina.it
  • URL: https://api.officina.it/v1/vehicles/{id}
  • Auth: HTTP bearer

Response

Vehicle found.

object'vehicle' required
idstring required
licensestring nullable

License plate (regional format, free-form string).

manufacturer_idstring required
manufacturer_namestring required

Joined from the manufacturers table for display. Read-only; mutate via manufacturer_id.

modelstring required
variantstring nullable
vinstring nullable

Vehicle Identification Number.

transmissionstring nullable
engine_power_kwinteger nullable
engine_displacement_ccminteger nullable
engine_codestring nullable

Codice motore. Stored trimmed and upper case (max 64 characters); an empty string or null clears it. When empty, officina.it may fill it from the vehicle's registration data. Shown in the app when field_visibility.engine_code is on.

vehicle_weight_kginteger nullable
engine_categorystring nullable
registered_atstring date-time nullable
commentsstring nullable
customer_idstring nullable
customer_namestring nullable

Joined from the owning customer's full_name for display. Read-only; mutate via customer_id.

kmnumber nullable

Most recently recorded odometer reading.

km_registered_atstring date-time nullable
last_inspection_atstring date-time nullable
next_inspection_atstring date-time nullable
next_appointmentstring date-time nullable

Earliest upcoming calendar appointment for this vehicle, computed at read time.

custom_fieldsobject nullable

Raw stored values keyed by custom field definition id (see VehicleCustomFieldValues for the stored shapes). Includes hidden fields, and on older records keys of deleted definitions (dropped on the next PATCH that sends custom_fields).

is_rentalboolean required

Whether this vehicle is part of the workshop's rental fleet. Read-only here — managed by the rental setup flow.

rental_daily_price_before_taxnumber nullable
rental_daily_price_taxnumber nullable
rental_daily_price_after_taxnumber nullable
rental_vat_codestring nullable
rental_daily_discount_ratenumber nullable
created_atstring date-time required
updated_atstring date-time required
deleted_atstring date-time nullable

Soft-deletion timestamp. Populated on the response from DELETE /v1/vehicles/{id}. Vehicles with a non-null deleted_at are not returned by list/detail endpoints — this field appears for the delete response only.

Example response

{
  "id": "2200ab13-7c48-4d52-b6e9-0a4f81c27d3e",
  "documents": [
    {
      "url": "/v1/vehicles/8821f0ac-5d2b-41e7-9a10-6c3f2b7d4e55/documents/3b91ee0c-19b4-4f0a-9c2e-7d51a0c88e14/download"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.