Skip to main content
The primary purpose of the Get Listings call is to retrieve specific collections of Listings based on your business or design needs.  The most common application for leveraging the Get Listings call is to create a custom landing page. The Way dashboard allows the Brand to choose up to 3 featured Listings.  The Get Listings call allows the developer to retrieve only the featured listings.  Having a reserved section of your landing page allocated for featured listings allows the Brand to actively influence the Listings that appear in the featured section via the Dashboard without any future coding changes. In order to retrieve featured listings using the Get Listings call, you can simply add the featured option as a get parameter: 
?featured=true

​
By Product Lines

The GetListings call also allows the developer to retrieve Listings by Product Line.  If, for instance, it was important that all resource-based experiences be shown ahead of host events, you can easily call getListings to display each set of experiences in 3 different sections.   In order to retrieve listings for a specific product line, you would call Get Listings using the following additional parameters: 
?productLines[]=host&productLines[]=activate&productLines[]=reserve

​
By Kinds

Kinds are another option when choosing which content to highlight on your landing page.  One of the most common scenarios we see on custom landing pages is to highlight upcoming events.  The kind filter for Get Listings allows you to retrieve events.  This endpoint can be used in conjunction with product line to return very specific product/experience combinations:  <link to product lines> To filter by product kinds, use the following parameter: 
?kinds[]=experience&kinds[]=resource&kinds[]=event

​
By Categories

If Categories are core to your site design, you may also choose to highlight listings related to a specific category.  Your site design may even call for dedicated landing pages for each category.  If that is the case, you’ll want to leverage the categories filter provided by the Get Listings call to return the appropriate listings.  This feature can be used to power filter options on a primary landing page or for a dedicated category page.  Filtering by categories happens as follows: 
?categories[0]=Arts&categories[1]=Cultural
Another flexible feature of the Get Listings call is the ability to search for a particular experience.  This can be used to power a search bar on your landing page.  You can search for a variety of different elements that belong to the listing, including:
  • Title
  • Description
  • Location Values (city, state, country)
The q parameter is used to require a search: 
?q=Yoga

​
Sorting

The Way dashboard allows Brand users to control the sort order for Listings.  The Brand user can either let the Listings sort naturally or the user can set the listings to appear in a specific order in the Dashboard.  The Get Listings call will automatically account for these ordering options.  However, if there is a need to override this sorting approach for specific call, that can be accomplished by using the following sort options: Sorting Options:
  • rating
  • startingPrice
  • createdAt
  • order
  • featuredOrder
A sort direction can also be provided - either Ascending (ASC) or Descending (DESC).  An example is included below: 
sortBy=startingPrice&sortDir=DESC