Accepts inquiries about properties, maintains search profiles and matches
the two automatically. Each inquiry gets a traceable score, so that
limited viewing-appointment slots go to the right leads.
Lead data is personal. Every record therefore carries a retention_until;
once it passes, the record is anonymized overnight. A deletion request is
carried out immediately via POST /leads/{id}/deletion.
API Base URL
- Server 1:https://api.realestateagency.example/v1
Production
- Server 2:https://sandbox.api.realestateagency.example/v1
Sandbox
Security
apiKey (apiKey)
Every call carries an API key in the apikey header. You generate the
key in the Real Estate portal under “My Apps”; it’s shown exactly once.
Each key has the scopes it’s allowed to use attached to it. If one is
missing, the API responds with 403 and code: "scope_missing"; the
missing scope is in details[].field.
Additional Information
Contact API Support - Real Estate Agency (api-support@realestateagency.example)