Passing property data to an external system

An external program such as a CRM or listing system can fetch the property list, the full data sheet of a property and its photos with an API key.

If an external program such as a CRM or an advert publishing system needs the property data regularly, the system's property interface provides it. It has no menu item: the external program requests the data with a user's API key and gets an answer only if that user holds the property export right.

What does the external program get?

  • Property list: property ID, own ID, status and last change. It can ask only for properties changed since a given time; one request returns at most 500 rows.
  • Data sheet: type and uses, titles and descriptions in every language, address and map coordinates, areas, rooms, year of construction, floor, the room list with a summary per level, utility meters and the list of photos and documents.
  • Photos: each photo can be downloaded as a JPEG image of at most 2048 pixels.

Setting up the connection

  1. Decide which user the connection runs as, and give that user's API key to the operator of the external program.
  2. Under Users → Permissions grant this user the property export function. Without it the external program receives "Permission denied."
  3. Check that the companies of the photos and documents fall into the user's API scope: only their files are passed on.
  4. Ask the operator of the external program to fetch regularly (for example hourly) only the properties changed since the last request, then their data sheets and photos.

Things to watch

The list and the data sheet include inactive properties too, and the text and figures of a property are passed on without a company restriction. Hand out only the key of a user for whom this is acceptable.

An invalid key returns "Invalid or missing API key."; a missing property returns "The property was not found."

Example

The CRM of Sample Ltd. asks every hour for the properties changed since 1 Nov 2026 08:00. From the data sheet of a changed property it takes the Hungarian, English and German titles, the 85 m² net area and the download addresses of 8 photos, then downloads each photo as a JPEG.

Related topics: REST API property permissions