Search
K
Leads & Inquiries

Leads & Inquiries

1.0.0OAS 3.0

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)

Leads

List leads

get

Query Parameters

search_profile_activeboolean
limitinteger

Default:25

>= 1<= 100

cursorstring

Response

application/json

Results list

dataarray
Show Child Parameters
pageobject

Cursor-based pagination.

Show Child Parameters
get/leads
 
application/json

Create a lead

post

Body

application/json

LeadInput

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

Response

application/json

Created

Lead

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
idstring

Example:lead_71ab

retention_untilstring(date)

Automatically set deletion deadline. Anonymized after it passes.

Example:2027-02-18

created_atstring(date-time)

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

post/leads

Body

{ "first_name": "Anna", "last_name": "Bergmann", "email": "a.bergmann@example.org", "phone": "+1 217 555 0142", "consent": { "purpose": "property_referral", "granted_at": "2026-08-18T10:22:00Z" }, "search_profile": { "type": [ "apartment" ], "locations": [ "Springfield" ], "rooms_min": 3, "purchase_price_max_eur": 700000 } }
 
application/json

Retrieve a lead

get

Path Parameters

leadIdstringrequired

Example:lead_71ab

Response

application/json

Lead

Lead

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
idstring

Example:lead_71ab

retention_untilstring(date)

Automatically set deletion deadline. Anonymized after it passes.

Example:2027-02-18

created_atstring(date-time)

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

get/leads/{leadId}
 
application/json