Get a vehicle search and its results

curl --request GET \
  --url https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}

const options = {method: 'GET'};

fetch('https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}', 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.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}",
  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.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}")

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

{
  "id": "srch_V1StGXR8Z5jdHi6BmyT2k",
  "status": "COMPLETED",
  "warning": {
    "code": "ALL_SUCCESS",
    "message": "All suppliers answered."
  },
  "createdAt": "2026-10-19T15:00:00.000Z",
  "searchParams": {
    "pickUpLocation": "sao-paulo-sp",
    "dropOffLocation": "sao-paulo-sp",
    "pickUpDate": "2026-11-02T10:00:00",
    "dropOffDate": "2026-11-05T10:00:00"
  },
  "type": "VEHICLE",
  "ttl": 1500,
  "facets": {},
  "next": "eyJwIjoyfQ==",
  "totalCount": 1,
  "items": [
    {
      "id": "srch_item_Rn2Xd8GuYc4Wv6ZkJe1Ta",
      "searchId": "srch_Hb7Yk1DrMv3Lq8UsAe0Xj",
      "groupName": "Economy",
      "class": "Economy",
      "name": "Fiat Mobi",
      "sipp": "EDMR",
      "pickUpLocation": {
        "name": "Aurora Rent - Aeroporto de Guarulhos",
        "phoneNumbers": [
          "+551133334444"
        ],
        "address": {
          "shortAddress": "Guarulhos, SP, Brazil",
          "adressLines": [
            "Rod. Hélio Smidt, s/n"
          ],
          "locality": "Guarulhos",
          "administrativeArea": "SP",
          "administrativeAreaName": "São Paulo",
          "postalCode": "07190-100",
          "country": "BR",
          "timezone": "America/Sao_Paulo",
          "coordinates": {
            "lat": -23.4356,
            "lng": -46.4731
          },
          "localityId": "<string>"
        }
      },
      "dropOffLocation": {
        "name": "Aurora Rent - Aeroporto de Guarulhos",
        "phoneNumbers": [
          "+551133334444"
        ],
        "address": {
          "shortAddress": "Guarulhos, SP, Brazil",
          "adressLines": [
            "Rod. Hélio Smidt, s/n"
          ],
          "locality": "Guarulhos",
          "administrativeArea": "SP",
          "administrativeAreaName": "São Paulo",
          "postalCode": "07190-100",
          "country": "BR",
          "timezone": "America/Sao_Paulo",
          "coordinates": {
            "lat": -23.4356,
            "lng": -46.4731
          },
          "localityId": "<string>"
        }
      },
      "pickUpDate": "2026-11-02T10:00:00",
      "dropOffDate": "2026-11-05T10:00:00",
      "model": "Mobi Like 1.0",
      "vehicleDetails": {
        "hasAirConditioning": true,
        "fuelType": "FLEX",
        "category": "Compact",
        "passengerQtd": 5,
        "luggageQtd": 2,
        "doorsQtd": 4,
        "transmissionType": "MANUAL",
        "includedMileage": "UNLIMITED"
      },
      "rentalCompany": {
        "code": "AUR",
        "name": "Aurora Rent",
        "logo": "https://example.com/logos/aurora-rent.svg"
      },
      "mainImage": {
        "uri": "https://example.com/vehicles/compact.jpg",
        "blurHash": "LEHV6nWB2yk8pyo0adR*.7kCMdnj",
        "dominantColor": "#c9d3dc"
      },
      "cheapestFare": {
        "id": "fare_Sv9Lc4TdHy1Qn6BwKe3Pr",
        "description": "Basic protection",
        "fare": {
          "currency": "BRL",
          "originalAmount": 48000,
          "discountAmount": 4800,
          "feeAmount": 1800,
          "amount": 45000,
          "cancellationPolicies": {
            "refundable": true,
            "immediateFine": false,
            "penalties": [
              {
                "from": "2026-10-30",
                "currency": "BRL",
                "fineAmount": 15000
              }
            ]
          },
          "changePolicies": {
            "canChange": true,
            "immediateFine": false,
            "penalties": [
              {
                "from": "2026-10-30",
                "currency": "BRL",
                "fineAmount": 15000
              }
            ]
          }
        }
      }
    }
  ]
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "SEARCH_NOT_FOUND",
  "origin": "TRAVEL",
  "message": "Search not found"
}

{
  "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"
    }
  ]
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "PROVIDER_UNAVAILABLE",
  "origin": "TRAVEL",
  "message": "Travel provider temporarily unavailable, please retry."
}

GET

realms

{realmId}

organizations

{organizationId}

vehicle

searches

{searchId}

Get a vehicle search and its results

curl --request GET \
  --url https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}

const options = {method: 'GET'};

fetch('https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}', 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.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}",
  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.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}")

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

{
  "id": "srch_V1StGXR8Z5jdHi6BmyT2k",
  "status": "COMPLETED",
  "warning": {
    "code": "ALL_SUCCESS",
    "message": "All suppliers answered."
  },
  "createdAt": "2026-10-19T15:00:00.000Z",
  "searchParams": {
    "pickUpLocation": "sao-paulo-sp",
    "dropOffLocation": "sao-paulo-sp",
    "pickUpDate": "2026-11-02T10:00:00",
    "dropOffDate": "2026-11-05T10:00:00"
  },
  "type": "VEHICLE",
  "ttl": 1500,
  "facets": {},
  "next": "eyJwIjoyfQ==",
  "totalCount": 1,
  "items": [
    {
      "id": "srch_item_Rn2Xd8GuYc4Wv6ZkJe1Ta",
      "searchId": "srch_Hb7Yk1DrMv3Lq8UsAe0Xj",
      "groupName": "Economy",
      "class": "Economy",
      "name": "Fiat Mobi",
      "sipp": "EDMR",
      "pickUpLocation": {
        "name": "Aurora Rent - Aeroporto de Guarulhos",
        "phoneNumbers": [
          "+551133334444"
        ],
        "address": {
          "shortAddress": "Guarulhos, SP, Brazil",
          "adressLines": [
            "Rod. Hélio Smidt, s/n"
          ],
          "locality": "Guarulhos",
          "administrativeArea": "SP",
          "administrativeAreaName": "São Paulo",
          "postalCode": "07190-100",
          "country": "BR",
          "timezone": "America/Sao_Paulo",
          "coordinates": {
            "lat": -23.4356,
            "lng": -46.4731
          },
          "localityId": "<string>"
        }
      },
      "dropOffLocation": {
        "name": "Aurora Rent - Aeroporto de Guarulhos",
        "phoneNumbers": [
          "+551133334444"
        ],
        "address": {
          "shortAddress": "Guarulhos, SP, Brazil",
          "adressLines": [
            "Rod. Hélio Smidt, s/n"
          ],
          "locality": "Guarulhos",
          "administrativeArea": "SP",
          "administrativeAreaName": "São Paulo",
          "postalCode": "07190-100",
          "country": "BR",
          "timezone": "America/Sao_Paulo",
          "coordinates": {
            "lat": -23.4356,
            "lng": -46.4731
          },
          "localityId": "<string>"
        }
      },
      "pickUpDate": "2026-11-02T10:00:00",
      "dropOffDate": "2026-11-05T10:00:00",
      "model": "Mobi Like 1.0",
      "vehicleDetails": {
        "hasAirConditioning": true,
        "fuelType": "FLEX",
        "category": "Compact",
        "passengerQtd": 5,
        "luggageQtd": 2,
        "doorsQtd": 4,
        "transmissionType": "MANUAL",
        "includedMileage": "UNLIMITED"
      },
      "rentalCompany": {
        "code": "AUR",
        "name": "Aurora Rent",
        "logo": "https://example.com/logos/aurora-rent.svg"
      },
      "mainImage": {
        "uri": "https://example.com/vehicles/compact.jpg",
        "blurHash": "LEHV6nWB2yk8pyo0adR*.7kCMdnj",
        "dominantColor": "#c9d3dc"
      },
      "cheapestFare": {
        "id": "fare_Sv9Lc4TdHy1Qn6BwKe3Pr",
        "description": "Basic protection",
        "fare": {
          "currency": "BRL",
          "originalAmount": 48000,
          "discountAmount": 4800,
          "feeAmount": 1800,
          "amount": 45000,
          "cancellationPolicies": {
            "refundable": true,
            "immediateFine": false,
            "penalties": [
              {
                "from": "2026-10-30",
                "currency": "BRL",
                "fineAmount": 15000
              }
            ]
          },
          "changePolicies": {
            "canChange": true,
            "immediateFine": false,
            "penalties": [
              {
                "from": "2026-10-30",
                "currency": "BRL",
                "fineAmount": 15000
              }
            ]
          }
        }
      }
    }
  ]
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "SEARCH_NOT_FOUND",
  "origin": "TRAVEL",
  "message": "Search not found"
}

{
  "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"
    }
  ]
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "PROVIDER_UNAVAILABLE",
  "origin": "TRAVEL",
  "message": "Travel provider temporarily unavailable, please retry."
}

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.

Path Parameters

realmId

string<uuid>

required

ID of your realm.

Format: UUID

organizationId

string<uuid>

required

ID of your organization.

Format: UUID

searchId

string

required

ID of the vehicle search, as returned when it was created.

Pattern: ^srch_[0-9A-Za-z]{21}$

Query Parameters

order

enum<string>

Sort direction applied to orderBy: ASC lists the cheapest results first, DESC the most expensive first.

Available options:

ASC,

DESC

orderBy

string

Field to sort the results by. Currently only amount is supported.

Minimum string length: 1

string

Cursor returned as next by the previous page. Omit for the first page.

Minimum string length: 1

limit

integer

Maximum number of items per page, from 1 to 100.

Required range: 1 <= x <= 100

minAmount

number

Only results costing at least this amount, in the same unit as the amount of the results (cents).

Required range: x >= 0

maxAmount

number

Only results costing at most this amount, in the same unit as the amount of the results (cents).

Required range: x >= 0

Response

Successful response

A vehicle search with, once it is COMPLETED, one page of its vehicles.

string

required

ID of the search.

Example:

"srch_V1StGXR8Z5jdHi6BmyT2k"

status

enum<string>

required

PROCESSING while the suppliers answer, then COMPLETED or FAILED. Only COMPLETED carries items.

Available options:

PROCESSING,

FAILED,

COMPLETED

Example:

"COMPLETED"

warning

object | null

required

How the search went across the suppliers. null while it is processing.

Show child attributes

createdAt

string<date-time>

required

When the search was created.

Example:

"2026-10-19T15:00:00.000Z"

searchParams

object

required

What the search was made for, as sent.

Show child attributes

type

enum<string>

required

Always VEHICLE.

Available options:

VEHICLE

Example:

"VEHICLE"

ttl

number

required

Seconds until the search expires (a vehicle search lasts 30 minutes).

Example:

1500

facets

object | null

required

Facets to build filters from (price ranges, categories, rental companies, with their counts). null until the search completes.

Show child attributes

string | null

Cursor for the next page. null on the last page. Present only once the search is COMPLETED.

Example:

"eyJwIjoyfQ=="

totalCount

number

Number of results that match the filters, across every page. Present only once the search is COMPLETED.

Example:

1

items

object[]

The vehicles of this page, filtered and sorted by the query parameters. Present only once the search is COMPLETED.

Show child attributes

Overview

Identity

Banking

Billing

Accounting

Registry

Platform

Notification

Rule Engine

Scheduling

Travel

Vehicles

Attachments

Get a vehicle search and its results

Path Parameters

Query Parameters

Response