> ## 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. # Get a vehicle search and its results > Returns a vehicle search and, once it has finished, one page of its vehicles. Searches are asynchronous: while `status` is `PROCESSING` only the search itself comes back, so poll until it is `COMPLETED`, then read `items`. A `FAILED` search has no results. A vehicle search expires after its `ttl` (30 minutes) and then answers `404 SEARCH_NOT_FOUND`. Only the organization that created a search can read it. Results come in pages. Sort them with `order` and `orderBy`, narrow them with `minAmount`, `maxAmount`, `category` and `rentalCompany`, then walk the pages with `limit` and the `next` cursor each response returns (`null` on the last page). A filter that takes several values accepts them repeated or comma-separated (`?category=Compact&category=SUV` or `?category=Compact,SUV`). Amounts are integers in cents: `98700` is R\$ 987,00. Each item is a summary with its cheapest fare. To book one, open it with the vehicle search item endpoint for everything a trip needs, and create the trip with the item's `id` as `searchItemId`. An error the travel provider reports about the request — a filter value it does not accept, say — is returned with its own status, `code` and `message`. ## OpenAPI ````yaml /api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId} openapi: 3.0.3 info: title: Travel version: 1.0.0 description: >- Portão 3 travel 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). Passenger directory, trips and the search proxy (air/hotel/bus/vehicle). Every route validates path, query and body through a zod Input class (`travel/src/domain/*/input`), which documents its parameters and body; responses are the named interfaces in `travel/src/domain/*/response.ts`. Confidence tiers: generated:typed=53 copied:manual=0 unknown=0. servers: - url: https://api.travel.v2.portao3.com.br/ description: production - url: https://api.travel.dev.3pers.com.br/ description: development security: [] tags: - name: Passengers - name: Trips - name: Air search - name: Hotel search - name: Bus search - name: Vehicle search paths: /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}: get: tags: - Vehicle search summary: Get a vehicle search and its results description: >- Returns a vehicle search and, once it has finished, one page of its vehicles. operationId: getRealmsByRealmIdOrganizationsByOrganizationIdVehicleSearchesBySearchId 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 your organization. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: searchId in: path required: true description: ID of the vehicle search, as returned when it was created. schema: type: string pattern: ^srch_[0-9A-Za-z]{21}$ example: srch_V1StGXR8Z5jdHi6BmyT2k - name: order in: query required: false description: >- Sort direction applied to `orderBy`: `ASC` lists the cheapest results first, `DESC` the most expensive first. schema: type: string enum: - ASC - DESC example: ASC - name: orderBy in: query required: false description: Field to sort the results by. Currently only `amount` is supported. schema: type: string minLength: 1 example: amount - name: next in: query required: false description: >- Cursor returned as `next` by the previous page. Omit for the first page. schema: type: string minLength: 1 example: eyJwIjoyfQ== - name: limit in: query required: false description: Maximum number of items per page, from 1 to 100. schema: type: integer minimum: 1 maximum: 100 example: 20 - name: minAmount in: query required: false description: >- Only results costing at least this amount, in the same unit as the `amount` of the results (cents). schema: type: number minimum: 0 example: 20000 - name: maxAmount in: query required: false description: >- Only results costing at most this amount, in the same unit as the `amount` of the results (cents). schema: type: number minimum: 0 example: 100000 - name: category in: query required: false description: >- Only vehicles of these categories, matched exactly and case-sensitive. --- Example (comma-separated list): `?category=Compact,SUV` schema: type: array items: type: string style: form explode: false - name: rentalCompany in: query required: false description: >- Only vehicles of these rental companies, by name, matched exactly and case-sensitive. --- Example (comma-separated list): `?rentalCompany=Aurora Rent,Via Carros` schema: type: array items: type: string style: form explode: false responses: '200': description: Successful response content: application/json: schema: type: object properties: id: type: string description: ID of the search. example: srch_V1StGXR8Z5jdHi6BmyT2k status: type: string enum: - PROCESSING - FAILED - COMPLETED description: >- `PROCESSING` while the suppliers answer, then `COMPLETED` or `FAILED`. Only `COMPLETED` carries `items`. example: COMPLETED warning: description: >- How the search went across the suppliers. `null` while it is processing. type: object properties: code: type: string enum: - ALL_FAILED - PARTIAL_SUCCESS - ALL_SUCCESS description: >- `ALL_SUCCESS`: every supplier answered. `PARTIAL_SUCCESS`: some suppliers failed, so the results may be incomplete. `ALL_FAILED`: no supplier answered. example: ALL_SUCCESS message: type: string description: Human-readable explanation. example: All suppliers answered. required: - code - message nullable: true createdAt: type: string description: When the search was created. example: '2026-10-19T15:00:00.000Z' format: date-time next: type: string nullable: true description: >- Cursor for the next page. `null` on the last page. Present only once the search is `COMPLETED`. example: eyJwIjoyfQ== totalCount: type: number description: >- Number of results that match the filters, across every page. Present only once the search is `COMPLETED`. example: 1 searchParams: type: object properties: pickUpLocation: type: string description: Pick-up place, as sent. example: sao-paulo-sp dropOffLocation: type: string description: Drop-off place, as sent. example: sao-paulo-sp pickUpDate: type: string description: Pick-up date and time, as sent. example: '2026-11-02T10:00:00' dropOffDate: type: string description: Drop-off date and time, as sent. example: '2026-11-05T10:00:00' required: - pickUpLocation - dropOffLocation - pickUpDate - dropOffDate description: What the search was made for, as sent. type: type: string enum: - VEHICLE description: Always `VEHICLE`. example: VEHICLE ttl: type: number description: >- Seconds until the search expires (a vehicle search lasts 30 minutes). example: 1500 facets: description: >- Facets to build filters from (price ranges, categories, rental companies, with their counts). `null` until the search completes. type: object additionalProperties: {} nullable: true items: type: array items: type: object properties: id: type: string description: >- ID of the item. Use it to load the item (every fare option); send it as `searchItemId` when you create a trip. example: srch_item_Rn2Xd8GuYc4Wv6ZkJe1Ta searchId: type: string description: ID of the search the item belongs to. example: srch_Hb7Yk1DrMv3Lq8UsAe0Xj groupName: type: string description: >- Name of the group of vehicles that fulfil the same booking class. example: Economy class: type: string description: Class of the vehicle. example: Economy name: type: string description: Commercial name of the vehicle. example: Fiat Mobi sipp: type: string description: SIPP (ACRISS) code of the vehicle. example: EDMR pickUpLocation: type: object properties: name: type: string description: Name of the station. example: Aurora Rent - Aeroporto de Guarulhos phoneNumbers: type: array items: type: string example: '+551133334444' description: >- Contact phone numbers. Empty when none is registered. --- Example: `["+551133334444"]` address: type: object properties: shortAddress: type: string nullable: true description: >- The address in a single line. `null` when unknown. example: Guarulhos, SP, Brazil adressLines: type: array items: type: string example: Rod. Hélio Smidt, s/n description: >- The address in postal lines. Empty when unknown. The field name is spelled `adressLines`. --- Example: `["Rod. Hélio Smidt, s/n"]` locality: type: string nullable: true description: City. `null` when unknown. example: Guarulhos administrativeArea: type: string nullable: true description: State or province code. `null` when unknown. example: SP administrativeAreaName: type: string nullable: true description: State or province name. `null` when unknown. example: São Paulo postalCode: type: string nullable: true description: Postal code. `null` when unknown. example: 07190-100 country: type: string description: Country (ISO 3166-1 alpha-2). example: BR timezone: type: string description: IANA time zone of the place, or `Unknown`. example: America/Sao_Paulo coordinates: description: Position of the place. `null` when unknown. type: object properties: lat: type: number description: Latitude, in decimal degrees. example: -23.4356 lng: type: number description: Longitude, in decimal degrees. example: -46.4731 required: - lat - lng nullable: true localityId: type: string nullable: true description: >- ID of the locality the bus station belongs to. Bus stations only; `null` when the station is not grouped under a locality. required: - shortAddress - adressLines - locality - administrativeArea - administrativeAreaName - postalCode - country - timezone - coordinates description: Address and position of the station. required: - name - phoneNumbers - address description: Where the vehicle is picked up. dropOffLocation: type: object properties: name: type: string description: Name of the station. example: Aurora Rent - Aeroporto de Guarulhos phoneNumbers: type: array items: type: string example: '+551133334444' description: >- Contact phone numbers. Empty when none is registered. --- Example: `["+551133334444"]` address: type: object properties: shortAddress: type: string nullable: true description: >- The address in a single line. `null` when unknown. example: Guarulhos, SP, Brazil adressLines: type: array items: type: string example: Rod. Hélio Smidt, s/n description: >- The address in postal lines. Empty when unknown. The field name is spelled `adressLines`. --- Example: `["Rod. Hélio Smidt, s/n"]` locality: type: string nullable: true description: City. `null` when unknown. example: Guarulhos administrativeArea: type: string nullable: true description: State or province code. `null` when unknown. example: SP administrativeAreaName: type: string nullable: true description: State or province name. `null` when unknown. example: São Paulo postalCode: type: string nullable: true description: Postal code. `null` when unknown. example: 07190-100 country: type: string description: Country (ISO 3166-1 alpha-2). example: BR timezone: type: string description: IANA time zone of the place, or `Unknown`. example: America/Sao_Paulo coordinates: description: Position of the place. `null` when unknown. type: object properties: lat: type: number description: Latitude, in decimal degrees. example: -23.4356 lng: type: number description: Longitude, in decimal degrees. example: -46.4731 required: - lat - lng nullable: true localityId: type: string nullable: true description: >- ID of the locality the bus station belongs to. Bus stations only; `null` when the station is not grouped under a locality. required: - shortAddress - adressLines - locality - administrativeArea - administrativeAreaName - postalCode - country - timezone - coordinates description: Address and position of the station. required: - name - phoneNumbers - address description: Where the vehicle is dropped off. pickUpDate: type: string description: >- Pick-up, in the local time of the station (`YYYY-MM-DDTHH:mm:ss`, no time-zone offset). example: '2026-11-02T10:00:00' dropOffDate: type: string description: >- Drop-off, in the local time of the station (`YYYY-MM-DDTHH:mm:ss`, no time-zone offset). example: '2026-11-05T10:00:00' model: type: string description: Model of the vehicle. example: Mobi Like 1.0 vehicleDetails: type: object properties: hasAirConditioning: type: boolean description: Whether the vehicle has air conditioning. example: true fuelType: type: string enum: - ELECTRIC - HYBRID - FLEX - DIESEL - GASOLINE - ETHANOL - LPG - HYDROGEN - NOT_INFORMED description: >- Fuel: `ELECTRIC`, `HYBRID`, `FLEX`, `DIESEL`, `GASOLINE`, `ETHANOL`, `LPG`, `HYDROGEN` or `NOT_INFORMED`. example: FLEX category: type: string description: Category label. example: Compact passengerQtd: type: number description: Passengers the vehicle seats. example: 5 luggageQtd: type: number description: Pieces of luggage the vehicle holds. example: 2 doorsQtd: type: number description: Number of doors. example: 4 transmissionType: type: string enum: - AUTOMATIC - MANUAL - NOT_INFORMED description: '`AUTOMATIC`, `MANUAL` or `NOT_INFORMED`.' example: MANUAL includedMileage: type: string description: Mileage included in the rental. example: UNLIMITED required: - hasAirConditioning - fuelType - category - passengerQtd - luggageQtd - doorsQtd - transmissionType - includedMileage description: Specifications of the vehicle. rentalCompany: type: object properties: code: type: string description: Code of the company. example: AUR name: type: string description: Commercial name. example: Aurora Rent logo: type: string nullable: true description: URL of the company's logo. `null` when unknown. example: https://example.com/logos/aurora-rent.svg required: - code - name - logo description: Company that rents the vehicle. mainImage: type: object properties: uri: type: string description: URL of the image. example: https://example.com/vehicles/compact.jpg blurHash: type: string description: >- BlurHash placeholder for previews. Omitted when unavailable. example: LEHV6nWB2yk8pyo0adR*.7kCMdnj dominantColor: type: string description: >- Dominant color, as hex. Omitted when unavailable. example: '#c9d3dc' required: - uri description: Main image of the vehicle. cheapestFare: type: object properties: id: type: string description: >- ID of the fare option. Send it as `fareId` when you create a trip with this item. example: fare_Sv9Lc4TdHy1Qn6BwKe3Pr description: type: string nullable: true description: >- Name of the fare option. `null` when not available. example: Basic protection fare: type: object properties: currency: type: string description: Currency of the amounts (ISO 4217). example: BRL originalAmount: type: number description: Price before discounts and fees, in cents. example: 48000 discountAmount: type: number description: >- Discount applied to the original amount, in cents. example: 4800 feeAmount: type: number description: Fees added to the rental, in cents. example: 1800 amount: type: number description: >- Total charged for the rental: `originalAmount - discountAmount + feeAmount`, in cents (`45000` is R$ 450,00). example: 45000 cancellationPolicies: type: object properties: refundable: type: boolean description: >- Whether the fare allows any refund at all. example: true immediateFine: type: boolean description: >- Whether a fine is charged for cancelling right after booking. example: false penalties: type: array items: type: object properties: from: type: string description: >- Date (`YYYY-MM-DD`) from which this tier applies. example: '2026-10-30' currency: type: string description: Currency of the penalty (ISO 4217). example: BRL fineAmount: type: number description: >- Penalty charged when cancelling or changing from `from` onward, in cents. example: 15000 required: - from - currency - fineAmount description: >- One tier of a cancellation or change penalty schedule. description: >- Penalty schedule, in effect from each tier's date. Empty or omitted when no scheduled penalty applies. required: - refundable - immediateFine description: >- Cancellation rules of the rate. Only in the item detail, not in the search results. changePolicies: type: object properties: canChange: type: boolean description: >- Whether the fare allows the booking to be changed. example: true immediateFine: type: boolean description: >- Whether a fine is charged for changing right after booking. example: false penalties: type: array items: type: object properties: from: type: string description: >- Date (`YYYY-MM-DD`) from which this tier applies. example: '2026-10-30' currency: type: string description: Currency of the penalty (ISO 4217). example: BRL fineAmount: type: number description: >- Penalty charged when cancelling or changing from `from` onward, in cents. example: 15000 required: - from - currency - fineAmount description: >- One tier of a cancellation or change penalty schedule. description: >- Penalty schedule, in effect from each tier's date. Empty when none applies. required: - canChange - immediateFine - penalties description: >- Change rules of the rate. Only in the item detail, not in the search results. Car rentals can't be changed today, so `canChange` is `false`. required: - currency - originalAmount - discountAmount - feeAmount - amount description: Price of the fare option. required: - id - description - fare description: >- The cheapest fare option. Absent when the vehicle has none. required: - id - searchId - groupName - class - name - sipp - pickUpLocation - dropOffLocation - pickUpDate - dropOffDate - model - vehicleDetails - rentalCompany - mainImage description: >- A vehicle in the search results, with its cheapest fare option. Load the item for every one. description: >- The vehicles of this page, filtered and sorted by the query parameters. Present only once the search is `COMPLETED`. required: - createdAt - facets - id - searchParams - status - ttl - type - warning description: >- A vehicle search with, once it is `COMPLETED`, one page of its vehicles. '404': description: >- `SEARCH_NOT_FOUND` — The search doesn't exist, has expired, was created by another organization or is not a vehicle search. 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: - SEARCH_NOT_FOUND description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - TRAVEL 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: SEARCH_NOT_FOUND origin: TRAVEL message: Search not found '422': description: >- `BAD_REQUEST` — A path parameter is not a valid ID or a 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: - TRAVEL 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: TRAVEL message: >- Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields. fields: - field: order message: 'Invalid option: expected one of "ASC"|"DESC"' code: ORDER_ONE_OF '503': description: >- `PROVIDER_UNAVAILABLE` — The travel provider could not be reached. Retry later. 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: - PROVIDER_UNAVAILABLE description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - TRAVEL 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: PROVIDER_UNAVAILABLE origin: TRAVEL message: Travel provider temporarily unavailable, please retry. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.