Search
K
[dev] 🇫🇷 Seeker Leads

Creates a new lead.

The route accepts a lead object in the request body to create a new lead.

post

Body

application/json

createLeadRequest

firstNamestring

Maximum length is 100 characters

>= 1 characters<= 100 characters

Example:Jane

lastNamestringrequired

Maximum length is 100 characters

>= 1 characters<= 100 characters

Example:Doe

genderstring

Allowed values:MALEFEMALEOTHERPREFER_NOT_TO_DISCLOSE

Example:FEMALE

emailstring(email)required

Example:test@example.com

languagestring

Allowed values:DEENESFRHEITNLPTRU

Default:FR

Example:FR

phoneNumbersarray[object]required

>= 1 characters

Show Child Parameters
messagestringrequired
classifiedIdstringrequired

Classified identifier in the format ^([0-9]{2})([1-9A-NP-Z]{10})$

Match pattern:^([0-9]{2})([1-9A-NP-Z]{10})$

submittedDatestring(date-time)required

The date and time when the lead was submitted in ISO 8601 format

Response

application/json

Immediate response with 200 status code

titlestring

A message indicating the lead was submitted successfully

requestIdstring

The ID of the request processing ID

post/leads

Body

{ "lastName": "Doe", "email": "test@example.com", "phoneNumbers": [ { "number": "+33511223344" } ], "message": "message", "classifiedId": "classifiedId", "submittedDate": "submittedDate" }
 
application/json

Returns a list of leads based on search criteria and pagination information.

The route accepts a list of search criteria alongside of pagination parameters.
To ensure successful request handling, limit calls to this endpoint to a maximum
of 10 concurrent requests every 200 milliseconds.

get

Query Parameters

minDateintegerrequired

Unix timestamp in seconds. The minimum ingestion date of the leads to be returned. Max period length is 7 days.

maxDateintegerrequired

Unix timestamp in seconds. The maximum ingestion date of the leads to be returned. Max period length is 7 days.

limitinteger

Number of items to be returned. Max is 100 items. Default is 100 items.

Default:100

>= 1<= 100

startstring

Returns existing leads after this leadId. If not provided, the first page will be returned.

Response

application/json

Paginated response with 200 status code

paginatedResultSet

metadataobject
Show Child Parameters
linksobject
Show Child Parameters
itemsOne Of
array
classifiedLeadobject
Show Child Parameters
get/leads
 
application/json

Returns details of the lead based on the provided lead id.

The route accepts a lead id as a part of path and returns the lead details.
To ensure successful request handling, limit calls to this endpoint to a maximum
of 10 concurrent requests every 200 milliseconds.

get

Path Parameters

leadIdstringrequired

The Lead unique identifier.

Response

application/json

Lead details response with 200 status code

One Of
metadataobjectrequired
Show Child Parameters
contactRequestobjectrequired

The data of the User who created the contact.
In rare cases, the User may have requested to delete their account / data on our Portals for GDPR Reasons.
In those cases:

  • the contact data fields (firstName, lastName, message, name, gender, language) will be set with null fields
  • the phoneNumbers will be replaced with an empty array: []
Show Child Parameters
propertyobjectrequired
Show Child Parameters
get/leads/{leadId}
 
application/json

Create a new subscription

Create a subscription with the given URL, API key, and status.
We can assign one or many url to the same real estate agency.
To ensure successful request handling, limit calls to this endpoint to a maximum
of 10 concurrent requests every 200 milliseconds.

post

Body

application/json

webhookSubscriptionAddRequest

urlstring(url)required

The URL to send new lead notifications to.

Example:https://example.com/webhook

apiKeystringrequired

The API key for authenticating webhook requests.

Example:12345-abcd-67890-xyz

statusstring

The status of the subscription.

Allowed values:ACTIVEINACTIVE

Response

application/json

Subscription created successfully

webhookSubscriptionResponse

subscriptionIdstringrequired

>= 1 characters

Example:D2IOuPcAq9s3sZ1pt3jW7

urlstring(url)required

The URL to send new lead notifications to.

Example:https://example.com/webhook

statusstringrequired

The status of the subscription.

Allowed values:ACTIVEINACTIVE

createdAtstring(date-time)required

Example:2025-01-01T10:00:00Z

updatedAtstring(date-time)required

Example:2025-01-01T10:00:00Z

post/webhook/subscriptions

Body

{ "url": "https://example.com/webhook", "apiKey": "12345-abcd-67890-xyz" }
 
application/json

List all subscriptions for a given partner and real estate agency

Returns a list of all subscriptions, including their subscription ID, URL, and status,
for a given partner and real estate agency.

get

Response

application/json

A list of subscriptions.

webhookSubscriptionListResponse

metadataobjectrequired
Show Child Parameters
itemsarray[object]required

Example:[{"subscriptionId":"550e8400-e29b-41d4-a716-446655440000","url":"https://example.com/webhook","status":"ACTIVE","createdAt":"2025-01-01T10:00:00Z","updatedAt":"2025-01-01T10:00:00Z"}]

Show Child Parameters
get/webhook/subscriptions
 
application/json