search_profile_activeboolean
limitinteger
Default:25
>= 1<= 100
cursorstring
List leads
get
Query Parameters
Response
application/json
Response
application/json
Results list
dataarray
Show Child Parameters
pageobject
Cursor-based pagination.
Show Child Parameters
get/leads
Authentication
Query Parameters
application/json
Create a lead
post
Body
application/json
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
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
Authentication
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
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}
Authentication
Path Parameters
application/json
Request deletion
Carries out a data subject’s rights request immediately. Personal
fields are permanently removed; activity that must be retained for
tax purposes remains pseudonymized.
post
Path Parameters
leadIdstringrequired
Example:lead_71ab
Body
application/json
Body
application/json
reasonstringrequired
Allowed values:data_subject_requestretention_expiredduplicate
sourcestring
Example:email dated 2026-08-18
Response
202 application/json
Response
202 application/json
Deletion initiated
lead_idstring
anonymized_atstring(date-time)
post/leads/{leadId}/deletion
Authentication
Path Parameters
Body
{
"reason": "data_subject_request"
}
202 application/json