property_idstringrequired
Example:prop_8f2c1a
lead_idstringrequired
Example:lead_71ab
messagestring
<= 2000 characters
channelstring
Allowed values:websiteportalphonetrade_fair
Record an inquiry
Typically called from the contact form on the agency’s own website.
post
Body
application/json
Body
application/json
Response
201 application/json
Response
201 application/json
Recorded
Inquiry
idstring
Example:inq_5c02
property_idstring
Example:prop_8f2c1a
lead_idstring
Example:lead_71ab
statusstring
Allowed values:newscoredinviteddeclinedclosed
Example:scored
channelstring
Example:website
messagestring
Example:Hello, is the apartment still available? We would like to view it.
received_atstring(date-time)
Example:2026-08-19T17:05:31Z
post/inquiries
Authentication
Body
{
"property_id": "prop_8f2c1a",
"lead_id": "lead_71ab"
}
201 application/json
Matching
Retrieve an inquiry's score
Shows how well the search profile and the property match - with the
individual criteria, so the rating stays traceable.
get
Path Parameters
inquiryIdstringrequired
Example:inq_5c02
Response
200 application/json
Response
200 application/json
Score
Score
inquiry_idstring
Example:inq_5c02
lead_idstring
Example:lead_71ab
pointsinteger
>= 0<= 100
Example:82
ratingstring
Allowed values:lowmediumhigh
criteriaarray[object]
Show Child Parameters
get/inquiries/{inquiryId}/score
Authentication
Path Parameters
200 application/json
Matching leads for a property
Returns leads with a matching search profile, sorted descending by score.
get
Query Parameters
min_pointsinteger
Default:60
>= 0<= 100
Path Parameters
propertyIdstringrequired
Example:prop_8f2c1a
Response
200 application/json
Response
200 application/json
Results
dataarray[object]
Show Child Parameters
get/matching/properties/{propertyId}
Authentication
Path Parameters
Query Parameters
200 application/json
Page
objectCursor-based pagination.
countinteger
Example:25
totalinteger
Example:138
next_cursorstring
Example:eyJzIjoyNX0
Example