Skip to main content
GET
/
api
/
v1
/
ops
/
vehicles
/
{vehicleId}
Get Vehicle
curl --request GET \
  --url https://api.example.com/api/v1/ops/vehicles/{vehicleId} \
  --header 'Authorization: Bearer <token>'
{
  "vehicleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "VAN",
  "licensePlate": "<string>",
  "model": "<string>",
  "manufacturer": "<string>",
  "year": 123,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
vehicleId
string<uuid>
required

Vehicle identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Veículos da frota de uma empresa de transporte

​
vehicleId
string<uuid>
required

Identificador único

​
companyId
string<uuid>
required

Referência à empresa

​
type
enum<string>
required

Tipo do veículo

Available options:
VAN
​
licensePlate
string
required

Placa do veículo

​
model
string
required

Modelo do veículo

​
manufacturer
string | null
required

Fabricante

​
year
integer | null
required

Ano de fabricação

​
floorCount
enum<string>
required

Quantidade de andares do veículo

Available options:
FIRST,
SECOND
​
status
enum<string>
required

Status do veículo

Available options:
ACTIVE,
INACTIVE
​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização

​
deletedBy
string<uuid> | null
required

Usuário que removeu o registro, quando aplicável

​
deletedAt
string<date-time> | null
required

Data de remoção