---
title: "Overview"
description: "This API turns a property record into a finished, publication-ready listing - as a PDF and as a web view."
url: "https://real-estate-agency.apim.eu/apis/listing-creation/docs/overview"
image: "https://real-estate-agency.apim.eu/_og/d/c_Ocean.takumi,title_Overview,description_~VGhpcyBBUEkgdHVybnMgYSBwcm9wZXJ0eSByZWNvcmQgaW50byBhIGZpbmlzaGVkLCBwdWJsaWNhdGlvbi1yZWFkeSBsaXN0aW5nIC0gYXMgYSBQREYgYW5kIGFzIGEgd2ViIHZpZXcu,props_eyJ0aGVtZSI6eyJtb2RlIjoiZGFyayIsImNvbG9ycyI6eyJwcmltYXJ5IjoiI0Q0QTI0QyJ9fX0,p_Ii9hcGlzL2xpc3RpbmctY3JlYXRpb24vZG9jcy9vdmVydmlldyI,s__nJuey1HsMNmvalD.png"
---

# Overview

This API turns a property record into a finished, publication-ready listing - as a PDF and as a web view.

## [What it's for](#what-its-for)

-   Automatically generating listings as soon as a property is fully entered
-   Delivering multilingual versions of the same property
-   Checking, before publication, whether all mandatory disclosures are present
-   Withdrawing existing listings from individual channels on demand

## [What it's not for](#what-its-not-for)

The API doesn't maintain property data. Title, price, floor area and the energy certificate belong in **Property Management**; the listing reads them from there. That keeps a single source of truth, so a price change doesn't need to be repeated in multiple places.

## [States of a listing](#states-of-a-listing)

| Status      | Meaning                                              |
| :---------- | :--------------------------------------------------- |
| in_progress | Generation is running, typically 2-10 seconds        |
| completed   | PDF is ready, not yet published                      |
| published   | Live on at least one channel                         |
| withdrawn   | Taken off every channel, document remains available  |
| failed      | Generation aborted, reason is in disclosures.missing |

Once generated, a listing is never modified afterwards. If the property changes, generate a new listing - that way it stays traceable which document a prospect was shown, and when.

## [Required scopes](#required-scopes)

| Call                                      | Scope          |
| :---------------------------------------- | :------------- |
| Read listings and templates, download PDF | listings:read  |
| Create, publish or withdraw a listing     | listings:write |