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
ErrorDetail
objectfieldstring
Example:consent.purpose
reasonstring
Example:missing
Example
Error
objectUniform 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