Seeker Leads API Documentation

Overview

The Seeker Leads API allows consumers to retrieve contact requests (leads) received by their customers (real estate agents) from the listings and agency pages published on our websites and applications.

Getting Started

Authentication

All API requests require a valid JWT bearer token. Include the token in the Authorization header:

Authorization: Bearer <your-jwt-token>

Base URLs

Use Cases

Retrieve Leads

Consumers can retrieve leads using two approaches:

1. Pagination-based retrieval: Use the GET /leads endpoint to fetch leads based on date range and pagination parameters.
2. Individual lead retrieval: Use the GET /leads/{leadId} endpoint to fetch a specific lead by its ID.

Webhook Subscriptions

For real-time lead notifications, consumers can subscribe to webhooks:

1. Create a subscription: Use POST /webhook/subscriptions to register a webhook URL.
2. Manage subscriptions: Update or delete subscriptions using the respective endpoints.
3. Monitor delivery: Use the audit endpoint to check webhook delivery status.

Rate Limits

To ensure successful request handling, limit calls to a maximum of 10 concurrent requests every 200 milliseconds.

Lead Categories

The API supports three types of leads:

Support

For questions and feedback, contact: leads-api@aviv-group.com