listingIdstringrequired
Identifier of the listing.
Example:lst_4d9b2e
Retrieve a listing
Returns status, metadata and the mandatory-disclosure report.
get
Path Parameters
Response
application/json
Response
application/json
Listing
Listing
idstring
Example:lst_4d9b2e
property_idstring
Example:prop_8f2c1a
template_idstring
Example:tpl_classic
languagestring
Example:en
statusstring
Lifecycle of a listing.
Allowed values:in_progresscompletedpublishedwithdrawnfailed
Example:completed
pdf_urlstring(uri)
Only set once status: completed. The link is valid for 24 hours.
Example:https://api.realestateagency.example/v1/listings/lst_4d9b2e/pdf
pagesinteger
Page count of the generated document.
Example:6
disclosuresobject
Result of the mandatory-disclosure check.
Show Child Parameters
created_atstring(date-time)
Example:2026-08-20T09:41:12Z
completed_atstring | null(date-time)
Example:2026-08-20T09:41:20Z
get/listings/{listingId}
Authentication
Path Parameters
application/json
Withdraw a listing
Takes a listing off every channel and marks it withdrawn.
The document remains available for record-keeping purposes.
delete
Path Parameters
listingIdstringrequired
Identifier of the listing.
Example:lst_4d9b2e
Response
Response
Withdrawn
delete/listings/{listingId}
Authentication
Path Parameters
Download listing as PDF
Returns the generated document. Only available once status is
completed - before that the API responds with 409.
get
Path Parameters
listingIdstringrequired
Identifier of the listing.
Example:lst_4d9b2e
Response
application/pdf
Response
application/pdf
PDF document
string
get/listings/{listingId}/pdf
Authentication
Path Parameters
application/pdf
Publish a listing
Puts the listing live on the chosen channels. Mandatory disclosures
are checked first.
post
Path Parameters
listingIdstringrequired
Identifier of the listing.
Example:lst_4d9b2e
Body
application/json
Body
application/json
channelsarray[string]required
Publication channel.
Allowed values:portalwebsitenewslettershop_window
>= 1 items
scheduled_forstring(date-time)
Optional time for a later, scheduled publication.
Response
application/json
Response
application/json
Published, or scheduled
Publication
listing_idstring
Example:lst_4d9b2e
statusstring
Lifecycle of a listing.
Allowed values:in_progresscompletedpublishedwithdrawnfailed
Example:completed
channelsarray[object]
Show Child Parameters
published_atstring(date-time)
Example:2026-08-20T09:44:03Z
post/listings/{listingId}/publish
Authentication
Path Parameters
Body
{
"channels": [
"portal",
"website",
"newsletter"
]
}
application/json
Templates
The agency’s design templates