Show your packages or saved lists on your own website with a single embed code, or call the same feed from a site you build yourself.
The Website Widget puts your listings on your own website: filters, property cards, a detail view and an enquiry form, all on your domain. Setting it up is four steps on one page: choose what to show, choose the API key, match your brand, then copy the embed.
Every list you switch on for your website feeds the same widget. Your website shows all of them together.For each list that is switched on, your website shows:
Packages matching the list’s saved search. New stock that matches appears on its own, with no need to add it.
Packages you added to the list by hand, even when they fall outside the search.
Nothing you removed from the list. Removing a package keeps it off your website, even if it still matches the search.
A few rules apply to every list:
Only available packages appear.
A list only shows stock its owner can see in the portal.
A package removed from one list still appears if another switched-on list includes it.
If you curate stock by region, keep one list per region and switch them all on. Keep adding packages to whichever list they belong in, the way you do today, and your website follows.
Your agency needs a portal site, and the Website widget switch at the top of the Website Widget page must be on.
Staff can open the Website Widget page. Only administrators can switch lists on or off there.
You need an API key with the scope of the feed you choose: website_packages, marketplace or lists. Create it on a dedicated user, such as website@yourcompany.com.au, with no other scopes, so the key can only read that feed. See API Keys.
Go to Agency Settings → Connectors and click Website Widget.
2
Choose what your website shows
Under step 1, choose Saved lists. Every list in your agency appears below with its owner and list ID. Switch on each list you want on your website. Each switch saves straight away.
3
Choose the API key
Under step 2, pick the key you created with the lists scope. Only keys with that scope are offered. If none is listed, click Create a key.
4
Match your brand
Under step 3, set the primary, secondary and accent colours. Click Save to keep them.
5
Copy the embed
Under step 4, pick the tab that fits your site. Script tag works on any HTML page. Wix and site builders gives you a custom element with steps for Wix, Squarespace and Webflow. Click Copy and paste the code where the listings should appear.
The embed code shows YOUR-API-KEY until you pick a key.
You only paste the code once. Switching a list on or off later changes your website straight away, with no change to the code.
If your website renders its own listings, skip the widget and call the feed directly. The API, no widget tab in step 4 shows the endpoint for the choice you made in step 1, and a ready-to-run request that sends your key as a Bearer token.Filters, sorting, pagination and the package fields are in the API reference.
A list’s owner can also put it on the website from the portal: open the list, click Share, and tick Serve this list to the website widget. It then appears switched on in the Website Widget page too.
To show a single list on a page, add its list ID to the embed code. You’ll find the ID next to each list on the Website Widget page, and the list’s Share window in the portal gives you this code ready to copy.
