Get Listings

Returns the authenticated user's listings, including disabled ones (listingEnabled: false). Each listing includes
property details, location information, current settings, and (when connected)
per-channel external IDs under channels (e.g. Airbnb listing id, Booking.com property id).
For direct booking, channels.direct lists only enabled sites with public URLs.

If both startDate and endDate query parameters are provided, the endpoint will
filter listings to only return those that are available for the specified date range.
This includes checking for blocked dates, minimum night requirements, and pricing availability.

Listings are returned newest first (most recently imported first). By default every listing comes back in one response. To page through a large account, pass limit, then pass the returned nextCursor as cursor to get the next page. Keep going until nextCursor is null. With startDate and endDate, a page can hold fewer than limit listings even when more remain, so don't stop at a short page — only stop when nextCursor is null.

To keep a copy of a large account up to date, don't fetch every listing on each poll. Fetch everything once, then pass updatedSince to get only the listings that changed, or use the listing webhooks.

Authentication: Pass either Authorization: Bearer <token> (OAuth 2.0) or the legacy authToken header.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Check-in date for availability filtering (YYYY-MM-DD format). Must be used with endDate.

string

Check-out date for availability filtering (YYYY-MM-DD format). Must be used with startDate.

integer
1 to 500

Maximum number of listings to return in one page (1-500). Omit it to get every listing in one response.

string

The nextCursor value from the previous page. Treat it as an opaque string: don't build or change it yourself.

string

Only return listings in this listing group.

boolean

Only return enabled listings (true) or disabled listings (false).

date-time

Only return listings that changed at or after this time (ISO 8601 date-time). Use it to poll for changes instead of fetching every listing each time: save the time just before each call, minus a minute for clock differences, and pass it as updatedSince on the next call. Works with limit and cursor. It doesn't report deleted listings (use the listing.deleted webhook), and a change to a listing group or direct booking site alone doesn't count as a listing change.

Headers
string

Partner API key (deprecated — use OAuth 2.0 for new integrations)

string

User's authentication token (legacy). Use Authorization Bearer header for new integrations.

Responses

429

Too many requests

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json