Skip to main content
GET
Get an air search and its results
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 air search expires after its ttl (15 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, airline, airlineCode and cabin, 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 (?airline=LA&airline=G3 or ?airline=LA,G3). 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 air search item endpoint for everything a trip needs, and create the trip with the item’s id as searchItemId. To compare flights by airline and price first, read the same results grouped into cards with the aggregate endpoint. 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 air 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
​
next
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
​
airline
string[]

Only flights sold by these airlines, by name (case-insensitive).

Example (comma-separated list): ?airline=LATAM,Gol

​
airlineCode
string[]

Only flights sold by these airlines, by IATA code (case-insensitive).

Example (comma-separated list): ?airlineCode=LA,G3

​
cabin
string[]

Only flights with a fare in these cabins: ECONOMY, PREMIUM_ECONOMY, BUSINESS, FIRST_CLASS or UNDEFINED. A flight is kept when at least one of its fares has a segment in one of them.

Example (comma-separated list): ?cabin=ECONOMY,BUSINESS

Response

Successful response

An air search with, once it is COMPLETED, one page of its flights.

​
id
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.

​
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.

​
type
enum<string>
required

Always AIR.

Available options:
AIR
Example:

"AIR"

​
ttl
number
required

Seconds until the search expires (a flight search lasts 15 minutes).

Example:

640

​
facets
object | null
required

Facets to build filters from (price ranges, airlines). null until the search completes.

​
next
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 flights of this page, filtered and sorted by the query parameters. Present only once the search is COMPLETED.