How can we help? 👋

Set up the listing widget

Configure the Listings Widget, choose eligible properties, and verify organization-wide or segmented listing links.

Set up the Listings Widget to show eligible properties on a shareable page or your website. Choose which listings appear, how pricing and contact information display, and which inquiry options prospects can use.

Before you start

  • Confirm the units you want to market are available in Aptly and marked Published for Rent.
  • Decide which board and filters should supply the listings.
  • Tour and application options depend on the products enabled for your account and the listing's settings.
  • If the widget will appear on your website, arrange access to your website editor or ask your web developer to add it.

1. Open Listing Settings

Go to Locations → Listings, then select Listings Settings in the sidebar. Open the Listings Widget tab.

Callouts: 1. Open Listings Widget. 2. Check Enable. 3. Copy the Website widget url. 4. Use Watermark Images and Watermark Size for the Aptly listing widget.
Callouts: 1. Open Listings Widget. 2. Check Enable. 3. Copy the Website widget url. 4. Use Watermark Images and Watermark Size for the Aptly listing widget.

2. Enable the widget and choose its listings

Turn on Enable.

Enabling the widget does not place it on your website. Use the Website widget url to share it directly, or provide that URL to your web developer for embedding.

Select the board

In Boards, choose the board that contains your listings. This is usually the Units board. Include Buildings if your team markets properties at the building level.

Apply a listing filter

The widget displays listings marked Published for Rent. Use Additional Listing Filter to narrow the organization-wide listing site. This filter does not apply to custom segments; each segment uses its own selected filter.

A published listing can still be excluded by the selected board or the filter for the link being viewed.

3. Map the listing details

For each selected board, review these fields:

  • Leasing Contact: Choose the contact field to display on listings. Leave it blank if you do not want contact information displayed.
  • Market Rent Field: Choose the field used for the displayed rent.
  • Deposit Field: Choose the field used for the security deposit.
  • Listing Logo Field: Use the company logo from Company Info & Team, or select a custom image field on the units.
Callouts: 1. Choose the source boards. 2. Map the default Leasing Contact. 3. Map the Market Rent, Listing Logo and Deposit fields.
Callouts: 1. Choose the source boards. 2. Map the default Leasing Contact. 3. Map the Market Rent, Listing Logo and Deposit fields.

4. Add inquiry and application details

Contact Us form

Choose an existing form or create one for widget inquiries. The selected form appears in the widget's Contact Us areas.

Contact information

Set a default inquiry contact. Individual listings can override this contact.

Lease package and estimated fees

If you use Aptly Screening, select a Lease Package to show prospects an estimated cost breakdown. Review the package and any listing-specific overrides before sharing the widget.

5. Customize the display

Image watermarks

A watermark uses the company name from Company Info & Team, appears across the center of listing images, and has an adjustable size. Check it in an individual listing's preview before sharing the widget.

Benefits

Add the company or resident benefits you want to display in the widget.

Search and amenities

Enable amenity filtering so prospects can narrow the displayed listings.

Listing ranges

Configure rent, square-footage, bed, and bath ranges on the individual listing, not in the widget settings.

Floor plans

For multi-family properties, displaying floor plans requires a Floor Plans board. Contact your account manager if you need this enabled.

Custom JavaScript

Use this field for tracking or analytics code when needed. Scripts run as entered, and errors can disrupt the widget. Have your developer test any script before using the widget publicly.

6. Create segmented links when needed

Use separate links for regions, property types, or other groups of listings.

  1. Create or select a board filter, such as California Properties.
  1. Turn on Enable Custom Listing Segments and create a segment using that filter.
  1. Review its name, filter, and listing count.
  1. Copy the segment's unique widget URL.
  1. Open that URL and confirm that it shows the intended listings before sharing or embedding it.
Callouts: 1. Review Additional Listing Filter for the organization-wide site. 2. Check Custom Listing Segments and their published/geocoded requirements. 3. Use each segment's own filter and Copy its link.
Callouts: 1. Review Additional Listing Filter for the organization-wide site. 2. Check Custom Listing Segments and their published/geocoded requirements. 3. Use each segment's own filter and Copy its link.

Custom segments require published listings with properly geocoded addresses. The organization-wide Additional Listing Filter does not apply to custom segments.

Segments can be edited or deleted. If you use only segmented links, check those links before turning off Enable organization-wide listing site.

7. Check the prospect experience

Open the exact URL you plan to share or embed. Confirm that:

  • The expected properties appear and excluded properties do not.
  • Rent, deposit, logo, photos, and contact information are correct.
  • The Contact Us form and any enabled tour or application links open the intended destination.
  • The embedded widget is usable on your website.

Do not submit a real application or create a tour solely to test a link.

Troubleshooting

A listing is missing

Check Published for Rent, the selected board, and the filter for the exact widget or segmented URL you are viewing. See Troubleshoot missing listings in the widget.

Pricing or contact information is wrong

Review the field mappings in Listing Settings, then check the corresponding unit data and any listing-level overrides.

A tour or application option is missing

Check that the relevant product is enabled and that the listing meets its showing or screening settings. Publishing a listing alone does not enable every action.

Related articles

Did this answer your question?
😞
😐
🤩