Generate, retrieve and publish
Returns the agency’s listings, optionally filtered by property and status.
Only listings for this property.
Example:prop_8f2c1a
Lifecycle of a listing.
Allowed values:in_progresscompletedpublishedwithdrawnfailed
Example:completed
Default:25
>= 1<= 100
Cursor from page.next_cursor of the previous response.
Results list
Cursor-based pagination.
Starts the generation of a listing from a property and a template.
Processing runs asynchronously; the response initially carries
status: "in_progress".
Property the listing is generated from.
Example:prop_8f2c1a
Design template of the agency.
Example:tpl_classic
Language of the generated document. Useful when marketing to international buyers.
Allowed values:enesfrde
Default:en
Content block of the listing.
Allowed values:locationfeaturesenergyfloor_plancommissionneighborhoodhistory
Internal remark; does not appear in the document.
<= 500 characters
Example:Owner prefers viewings starting September 1st.
Generation accepted
Example:lst_4d9b2e
Example:prop_8f2c1a
Example:tpl_classic
Example:en
Lifecycle of a listing.
Allowed values:in_progresscompletedpublishedwithdrawnfailed
Example:completed
Only set once status: completed. The link is valid for 24 hours.
Example:https://api.realestateagency.example/v1/listings/lst_4d9b2e/pdf
Page count of the generated document.
Example:6
Result of the mandatory-disclosure check.
Example:2026-08-20T09:41:12Z
Example:2026-08-20T09:41:20Z
Returns status, metadata and the mandatory-disclosure report.
Identifier of the listing.
Example:lst_4d9b2e
Listing
Example:lst_4d9b2e
Example:prop_8f2c1a
Example:tpl_classic
Example:en
Lifecycle of a listing.
Allowed values:in_progresscompletedpublishedwithdrawnfailed
Example:completed
Only set once status: completed. The link is valid for 24 hours.
Example:https://api.realestateagency.example/v1/listings/lst_4d9b2e/pdf
Page count of the generated document.
Example:6
Result of the mandatory-disclosure check.
Example:2026-08-20T09:41:12Z
Example:2026-08-20T09:41:20Z
Takes a listing off every channel and marks it withdrawn.
The document remains available for record-keeping purposes.
Identifier of the listing.
Example:lst_4d9b2e
Withdrawn