Listings

Endpoint	Method	Scope	Description
/api/v1/listings/	GET	listings:read	List all listings (paginated)
/api/v1/listings/<id>/	GET	listings:read	Get listing details
/api/v1/listings/<id>/activation/	PATCH	listings:write	Enable or disable price syncing for a listing
/api/v1/listings/<id>/refresh/	POST	listings:write	Queue a full refresh (listing details and reservations) for a listing
/api/v1/listings/<id>/customizations/<type>/	GET, PATCH	listings:read, listings:write	Retrieve or update listing customizations

Try it out

Explore parameters, schemas, and live requests in the Swagger UI.

List Listings

Returns a paginated list of all listings for the authenticated application. Supports pagination and sorting, and filtering by owner and enabled status.

Get Listing Details

Returns detailed information about a specific listing.

Compound Documents (Sideloading)

Include related resources in a single request using the ?include= parameter:

• owner -- the user who owns the listing

This avoids a separate API call to fetch the owner. See the JSON:API guide for details on how compound documents work.

Listing Activation

Use the listing activation endpoint to enable or disable price syncing for a listing.

When enabling a listing, the activation payload includes enabled and can also include pricing values such as base-price and min-price. Newly synced listings are created disabled, so this is the endpoint used in the final step of the partner onboarding flow.

See the interactive schema and examples in the Swagger UI.

Listing Refresh

Use the listing refresh endpoint to enqueue an asynchronous full refresh for a listing's primary channel listing. This refreshes the listing's details and availability, then its reservations, and finally recomputes the automatic base price.

This endpoint returns immediately with a 202 Accepted response after the jobs have been queued.

Listing Customizations

Use the Listing Customizations endpoints to retrieve and update pricing and stay-rule settings for a specific listing.

Supported customization types include:

• min-stays
• extra-guest-fees
• max-stays
• min-max-prices
• time-based-adjustments
• checkin-checkout-days