Skip to main content
GET
Get all listings

Authorizations

Authorization
string
header
required

Your brand's secret API key, e.g. Bearer way_sk_live_bhEqcn0i1fRoUEHBPjJkQA. The key names the brand, so a brandId in the path must be your own brand. Older Way-Brand-Id + Way-Secret-Key credentials still work: see Legacy authentication.

Headers

Way-Brand-Id
string<uuid>

The brand to scope the response to. Required with an organization key. Ignored with a brand key, which already names its brand.

Query Parameters

categoryIds
string[]

Only listings in these categories. IDs come from the Get categories endpoint.

isUnlisted
default:false

Set to true to return unlisted listings instead of publicly listed ones.

language
string

Locale for translated content; defaults to the brand's language.

limit
number
default:10

Number of items per page.

Required range: x >= 0
page
number
default:1

Page number to return, starting at 1.

Required range: x >= 1
productLines
enum<string>[]

Only listings from these product lines.

Available options:
activate,
host,
reserve
sortBy
enum<string>

Field to sort the results by.

Available options:
category,
createdAt,
status,
title,
listingOrder
sortDir
enum<string>

Sort direction.

Available options:
ASC,
DESC
vibeIds
string[]

Only listings with these vibes. IDs come from the Get vibes endpoint.

Response

200 - application/json
items
object[]
required

The listings on this page of results.

meta
object
required

Pagination metadata for the result set.

Links for navigating between pages of results.