Search
K
[dev] 🇫🇷 Seeker Leads

Seeker leads API & Webhook France

1.4.0OAS 3.0

The Seeker leads API allows consumers to retrieve contact requests (leads) received by their customers (real estate agents) from the listings & agency pages published on our websites & applications. The consumer can subscribe to webhook notifications, or retrieve the leads based on search criteria and pagination parameters. The onboarding process & advice is available in the “Use cases” menu of the developer portal. Please share your questions & feedbacks on the following address : leads-api@aviv-group.com

API Base URL
  • Server 1:https://api.aviv-group.com/seeker-leads/v1

    Production server

  • Server 2:https://api.aviv-group.com/sandbox/seeker-leads/v1

    Sandbox

Security
bearerAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

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