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
- 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
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
| 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
| Call | Scope |
|---|---|
| Read listings and templates, download PDF | listings:read |
| Create, publish or withdraw a listing | listings:write |