Leads & Inquiries

Error

object

Uniform error format across all Real Estate Agency APIs.

codestringrequired

Example:validation_failed

messagestringrequired

Example:Consent is required to create a lead.

detailsarray[object]
Show Child Parameters
Example

InquiryStatus

string

Allowed values:newscoredinviteddeclinedclosed

Example

Consent

object

Record of consent under applicable data protection law.

purposestringrequired

Allowed values:property_referralnewsletter

granted_atstring(date-time)required

Example:2026-08-18T10:22:00Z

revoked_atstring(date-time)
Example

SearchProfile

object
typearray[string]

Allowed values:apartmenthouselandcommercial

locationsarray[string]

Example:Springfield

rooms_minnumber(float)

Example:3

living_area_min_sqmnumber(float)

Example:75

purchase_price_max_eurinteger

Example:700000

cold_rent_max_eurinteger

Example:1600

financing_proofboolean
Example

LeadInput

object
first_namestring

Example:Anna

last_namestringrequired

Example:Bergmann

emailstring(email)required

Example:a.bergmann@example.org

phonestring

Example:+1 217 555 0142

consentobjectrequired

Record of consent under applicable data protection law.

Show Child Parameters
search_profileobject
Show Child Parameters
Example