List vehicles
curl --request GET \
--url https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehiclesimport requests
url = "https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "6710b8e4c9e77b0012a4d6f1",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"name": "Delivery van 07",
"licensePlate": "BRA2E19",
"make": "Fiat",
"model": "Fiorino",
"year": 2023,
"status": "ACTIVE",
"external": {
"walletId": "6710b8e4c9e77b0012a4d6f3",
"accountId": "66f2a1c7b4d3e80012c9a0b4"
},
"customFields": {
"cost-center": "CC-1020"
},
"createdBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"updatedBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"createdAt": "2026-10-17T13:45:12.000Z",
"updatedAt": "2026-10-17T13:45:12.000Z",
"wallet": {
"id": "6710b8e4c9e77b0012a4d6f3",
"name": "BRA2E19",
"status": "ACTIVE",
"currency": "986",
"totalBalance": 35000,
"balances": [
{
"category": "GAS",
"amount": 35000
}
],
"shared": [
{
"id": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"role": "OWNER",
"firstName": "Mariana",
"lastName": "Costa",
"email": "mariana.costa@acme.com.br"
}
]
}
}
],
"next": "MjAyNi0xMC0xN1QxMzo0NToxMi4wMDBa"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "VEHICLE_MEMBERSHIP_REQUIRED",
"origin": "VEHICLE",
"message": "Organization membership required"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "VEHICLE",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "name",
"message": "Too big: expected string to have <=256 characters",
"code": "NAME_MAX"
}
]
}List vehicles
Lists the organization’s vehicles, newest first.
GET
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
vehicles
List vehicles
curl --request GET \
--url https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehiclesimport requests
url = "https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vehicle.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "6710b8e4c9e77b0012a4d6f1",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"name": "Delivery van 07",
"licensePlate": "BRA2E19",
"make": "Fiat",
"model": "Fiorino",
"year": 2023,
"status": "ACTIVE",
"external": {
"walletId": "6710b8e4c9e77b0012a4d6f3",
"accountId": "66f2a1c7b4d3e80012c9a0b4"
},
"customFields": {
"cost-center": "CC-1020"
},
"createdBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"updatedBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"createdAt": "2026-10-17T13:45:12.000Z",
"updatedAt": "2026-10-17T13:45:12.000Z",
"wallet": {
"id": "6710b8e4c9e77b0012a4d6f3",
"name": "BRA2E19",
"status": "ACTIVE",
"currency": "986",
"totalBalance": 35000,
"balances": [
{
"category": "GAS",
"amount": 35000
}
],
"shared": [
{
"id": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"role": "OWNER",
"firstName": "Mariana",
"lastName": "Costa",
"email": "mariana.costa@acme.com.br"
}
]
}
}
],
"next": "MjAyNi0xMC0xN1QxMzo0NToxMi4wMDBa"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "VEHICLE_MEMBERSHIP_REQUIRED",
"origin": "VEHICLE",
"message": "Organization membership required"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "VEHICLE",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "name",
"message": "Too big: expected string to have <=256 characters",
"code": "NAME_MAX"
}
]
}Each vehicle comes with its dedicated
wallet — its balance and the users who can use it. A vehicle whose wallet can’t be read at that moment is returned without one; send includeWallet=false to leave the wallets out altogether, which is faster.
Filter by name and licensePlate (both match part of the text, ignoring case), status or walletId, and page with limit + next. status takes its values comma-separated (?status=ACTIVE,ARCHIVED); repeating the parameter (?status=ACTIVE&status=ARCHIVED) works too. A blank parameter counts as not sent.Path Parameters
ID of your realm.
Format: UUID
ID of the organization whose vehicles you want to list.
Format: UUID
Query Parameters
Only vehicles whose name contains this text (case-insensitive).
Maximum string length:
256Only vehicles whose license plate contains this text. Case, hyphens and spaces are ignored.
Maximum string length:
16Only vehicles in these statuses. Omit to list both.
Example (comma-separated list): ?status=ACTIVE,ARCHIVED
Available options:
ACTIVE, ARCHIVED Only the vehicle whose dedicated wallet has this ID (its external.walletId).
Required string length:
1 - 64false returns the vehicles without their wallet, which is faster.
Available options:
true, false Cursor returned as next by the previous page. Omit for the first page.
Page size.
Required range:
1 <= x <= 100Sort direction of orderBy. Case-insensitive.
Available options:
ASC, DESC Field to sort by. Only createdAt is supported.
Available options:
createdAt