Skip to content

Show your listings on your website

Website sync keeps your own website up to date with the properties in LintelCRM. Your website developer reads a feed of your listings with an API key. You change a property, price or photo in the CRM, and the website shows it the next time it reads the feed. Website sync is listed as a Professional plan feature.

The feed is a read-only list of your properties in a fixed format called listing.v1. Each listing has:

  • The name, address and map position, the type, and whether it is for sale or to let.
  • The status, for example available, under offer or withdrawn.
  • A headline with the price (rent per month, or the sale price), bedrooms, bathrooms and size.
  • The description, and the units in the property.
  • Photos and floor plans, as web addresses. The images stay on LintelCRM and your website links to them, so nothing is copied.
  • enquiry_embed_url, the address of your enquiry form for that property, so the website can show the form.
  • external_ref, your own reference for the property if it came from an import, so a website can match an existing page.
  • When it was created and last updated.

For a sale it also shows the sale type and, when a tenant stays in place, the tenancy details such as rent and yield. A block listed unit by unit is shown as one listing per unit.

You need permission to manage API keys, which owners and admins have. Your developer does the work on the website. You do these steps:

  1. Open Settings and choose API Keys. Under Your property feed, select Copy beside the Feed URL.
  2. Select Generate New Key, name it after the website, and copy the key when it is shown. It is shown only once. See API keys.
  3. Give your developer the feed URL, the key and the link View listing.v1 schema. Send the key in a safe way.
  4. Turn on your enquiry form if you want visitors to enquire from the listing. See Leads and the enquiry form.
  5. Ask your developer to check that the listings appear, then watch Last used in the keys table. It changes from Never once the website reads the feed.

The key goes in the request as a bearer token, for example Authorization: Bearer lcrm_.... The feed address is your CRM address followed by /public/v1/listings. A single listing is at /public/v1/listings/{id}.

A property is in the feed when it belongs to your agency and is not archived. These are left out:

  • A property with the status Withdrawn, unless the website asks for withdrawn listings.
  • A to-let property that has been Sold.
  • A property for sale whose sales instruction is still Pre-market. It appears once you use Put on the market. See Vendors and instructions.

Add the property, photos, description and prices as usual. See Add a property and Photos and documents. Only the photo collections for the gallery and floor plan go to the feed.

Your developer can ask for only what changed, so the website does not reread everything. The feed supports these options:

  • updated_since: only listings changed after a date and time.
  • page[size]: how many listings per page, from 1 to 100. The default is 50.
  • cursor: the value in meta.next_cursor, to fetch the next page.
  • purpose: to_let or for_sale.
  • status: one or more statuses.
  • include_withdrawn=true: also return withdrawn listings, marked as withdrawn, so the website can remove them.

The response carries the schema name listing.v1 in meta.schema and in the X-Listing-Schema header. A change to a property or its photos updates its updated time, so the next updated_since request returns it. To be told when something changes instead of checking on a timer, create a webhook on the property events, such as Property updated. Most property events need the Business plan or above. See Webhooks.

  • A property is withdrawn or archived. Archived properties leave the feed. A withdrawn one is left out too, unless the website asks with include_withdrawn=true. Tell your developer to ask for withdrawn listings, or the website will keep showing a property you have taken off the market.
  • A sale is still Pre-market. It is not in the feed until you put it on the market. A to-let advert on the same property is not affected.
  • The enquiry form is off. enquiry_embed_url is empty, so the listing has no form to show. Turn the form on in Settings, Enquiry Form.
  • A key is revoked, expired or missing. The feed answers 401 and the website shows no listings. Generate a new key and give it to your developer. See API keys.
  • The website asks too often. After 60 requests a minute (the default) the feed answers 429 with a Retry-After time. Ask only for changes with updated_since.
  • A listing is not found. Asking for one property that is not yours, or is not on the market, returns 404.
  • The agency account is not in good standing. The feed stops answering until the account is back in good standing. See Billing and your plan.
  • Your plan is below Professional. Website sync is listed as a Professional feature. Check your plan in Billing and your plan.