> ## Documentation Index > Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt > Use this file to discover all available pages before exploring further. # List vehicles > Lists the organization's vehicles, newest first. 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. ## OpenAPI ````yaml /api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles openapi: 3.0.3 info: title: Vehicle version: 1.0.0 description: >- Portão 3 vehicle API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). Fleet vehicles, each with a dedicated wallet. Confidence tiers: generated:typed=9 copied:manual=0 unknown=0. servers: - url: https://api.vehicle.v2.portao3.com.br/ description: production - url: https://api.vehicle.dev.3pers.com.br/ description: development security: [] tags: - name: Vehicles paths: /realms/{realmId}/organizations/{organizationId}/vehicles: get: tags: - Vehicles summary: List vehicles description: Lists the organization's vehicles, newest first. operationId: getRealmsByRealmIdOrganizationsByOrganizationIdVehicles parameters: - name: realmId in: path required: true description: |- ID of your realm. Format: `UUID` schema: type: string format: uuid example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b - name: organizationId in: path required: true description: |- ID of the organization whose vehicles you want to list. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: name in: query required: false description: Only vehicles whose name contains this text (case-insensitive). schema: type: string maxLength: 256 example: van - name: licensePlate in: query required: false description: >- Only vehicles whose license plate contains this text. Case, hyphens and spaces are ignored. schema: type: string maxLength: 16 example: BRA2 - name: status in: query required: false description: |- Only vehicles in these statuses. Omit to list both. --- Example (comma-separated list): `?status=ACTIVE,ARCHIVED` schema: type: array items: type: string enum: - ACTIVE - ARCHIVED style: form explode: false - name: walletId in: query required: false description: >- Only the vehicle whose dedicated wallet has this ID (its `external.walletId`). schema: type: string minLength: 1 maxLength: 64 example: 6710b8e4c9e77b0012a4d6f3 - name: includeWallet in: query required: false description: >- `false` returns the vehicles without their `wallet`, which is faster. schema: default: 'true' type: string enum: - 'true' - 'false' example: 'false' - name: next in: query required: false description: >- Cursor returned as `next` by the previous page. Omit for the first page. schema: type: string example: MjAyNi0xMC0xN1QxMzo0NToxMi4wMDBa - name: limit in: query required: false description: Page size. schema: default: 15 type: integer minimum: 1 maximum: 100 example: 15 - name: order in: query required: false description: Sort direction of `orderBy`. Case-insensitive. schema: default: DESC type: string enum: - ASC - DESC example: DESC - name: orderBy in: query required: false description: Field to sort by. Only `createdAt` is supported. schema: default: createdAt type: string enum: - createdAt example: createdAt responses: '200': description: Successful response content: application/json: schema: type: object properties: items: type: array items: type: object properties: id: type: string description: ID of the vehicle. example: 6710b8e4c9e77b0012a4d6f1 realmId: type: string description: ID of the realm the vehicle belongs to. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid organizationId: type: string description: ID of the organization the vehicle belongs to. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 format: uuid name: type: string description: Display name of the vehicle. example: Delivery van 07 licensePlate: type: string description: >- License plate, upper-cased with no hyphen or space: the old Brazilian format (`ABC1234`) or the Mercosul one (`ABC1D23`). example: BRA2E19 make: type: string description: Manufacturer. example: Fiat model: type: string description: Model. example: Fiorino year: type: number description: Model year. example: 2023 status: type: string enum: - ACTIVE - ARCHIVED description: >- `ACTIVE`, or `ARCHIVED` once the vehicle was archived. An archived vehicle's wallet is blocked. example: ACTIVE external: type: object properties: walletId: type: string description: >- ID of the vehicle's dedicated wallet. Use it with the wallet, card and transaction endpoints of the Banking API. example: 6710b8e4c9e77b0012a4d6f3 accountId: type: string description: >- ID of the organization's account the wallet belongs to. example: 66f2a1c7b4d3e80012c9a0b4 required: - walletId - accountId description: The vehicle's dedicated wallet. customFields: type: object additionalProperties: {} description: >- Values of the organization's vehicle custom fields, keyed by the custom field's `slug`. Empty when none were set. --- Example: `{"cost-center":"CC-1020"}` example: cost-center: CC-1020 createdBy: type: string description: ID of the user who registered the vehicle. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 format: uuid updatedBy: type: string description: ID of the user who last changed the vehicle. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 format: uuid createdAt: type: string description: When the vehicle was registered. example: '2026-10-17T13:45:12.000Z' format: date-time updatedAt: type: string description: When the vehicle was last changed. example: '2026-10-17T13:45:12.000Z' format: date-time wallet: type: object properties: id: type: string description: >- ID of the wallet — the same as the vehicle's `external.walletId`. example: 6710b8e4c9e77b0012a4d6f3 name: type: string nullable: true description: >- Name of the wallet: the vehicle's license plate when it was registered. Changing the vehicle's plate later doesn't rename the wallet. example: BRA2E19 status: type: string enum: - PENDING - ACTIVE - CANCELLING - CANCELLED - BLOCKED - REPROVED - FRAUD_ANALYSIS - FRAUD_CONFIRMED description: >- Status of the wallet. `BLOCKED` while the vehicle is archived. example: ACTIVE currency: type: string description: >- Currency of the balances, as an ISO 4217 numeric code (`986` = BRL). example: '986' totalBalance: type: number description: >- Total balance of the wallet across all of its categories, in cents. example: 35000 balances: type: array items: type: object properties: category: type: string enum: - FLEX_NATIONAL - FLEX_INTERNATIONAL - FOOD - GAS - MOBILITY - TOLL - FLEX_NATIONAL_WITHOUT_WITHDRAWALS - ADS - SAAS - HOTEL - AIRLINES - TRAVEL - BLOCKED - CASHBACK description: Balance category. example: GAS amount: type: number description: Balance of the category, in cents. example: 35000 required: - category - amount description: The balance of one category of the wallet. description: >- Balance per category. Empty while the wallet is being created. shared: type: array items: type: object properties: id: type: string description: ID of the user. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 format: uuid role: type: string enum: - OWNER - USER - READ_ONLY description: >- What the user can do with the wallet: `OWNER` manages it, `USER` spends from it, `READ_ONLY` only sees it. example: OWNER firstName: type: string description: First name of the user. example: Mariana lastName: type: string description: Last name of the user. example: Costa email: type: string description: E-mail of the user. example: mariana.costa@acme.com.br required: - id - role - firstName - lastName - email description: A user who can use the vehicle's wallet. description: Users who can use the wallet, and how. required: - id - name - status - currency - totalBalance - balances - shared description: >- The vehicle's dedicated wallet. Omitted when the wallet can't be read at that moment (the vehicle itself is still returned), or when the list was requested with `includeWallet=false`. required: - customFields - external - id - licensePlate - make - model - name - organizationId - realmId - status - year description: A vehicle, with its wallet's balance and users. description: Vehicles, newest first unless `order=ASC`. next: type: string nullable: true description: Cursor for the next page. `null` on the last page. example: MjAyNi0xMC0xN1QxMzo0NToxMi4wMDBa required: - items - next description: A page of vehicles. '403': description: >- `VEHICLE_MEMBERSHIP_REQUIRED` — You are not a member of the organization. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - VEHICLE_MEMBERSHIP_REQUIRED description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - VEHICLE description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: VEHICLE_MEMBERSHIP_REQUIRED origin: VEHICLE message: Organization membership required '422': description: >- `BAD_REQUEST` — A path or query parameter is invalid; `fields` lists each one. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BAD_REQUEST description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - VEHICLE description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. fields: type: array description: >- One entry per invalid request field (validation errors only). items: type: object properties: field: type: string description: >- Path of the invalid field, e.g. `label` or `values[0].value`. example: label message: type: string description: Why the field was rejected. example: label is required code: type: string description: >- `_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`. example: LABEL_REQUIRED values: type: array items: type: string description: >- The accepted values, when the field is an enumeration. required: - field - message - code required: - traceId - code - origin - message example: 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.