← Home Get Story Leads

Get Story Leads

GEThttps://api.bayut.com/v1/leads

Retrieves a paginated list of Story leads based on specified filters like channel, target, type, agency IDs, and date range.

🔐 Bearer Token: Provide your bearer token in the Authorization header when making requests to protected resources.

Query Parameters

Name	Type	Required	Description	Example
channel	string	Optional	The source channel of the lead (e.g., whatsapp, website).	website
target	string	Optional	Lead target type (e.g., listing).	listing
type	string	Optional	Type of lead (e.g., story).	story
agency_ids[]	string	Optional	List of agency IDs to filter leads by specific agencies.
created_from	string	Optional	Start date for filtering leads (YYYY-MM-DD).	2025-10-01
created_to	string	Optional	End date for filtering leads (YYYY-MM-DD).	2025-10-08
page	string	Optional	Page number for pagination. Default: 1.	1
per_page	string	Optional	Number of items per page. max: 100.	50

Response Schema

Name	Type	Required
data	array[object]	Optional
lead	object	Optional
agent_details	object	Optional
inquirer_details	object	Optional
story_details	object	Optional
meta	object	Optional
current_page	integer	Optional
from	integer	Optional
to	integer	Optional
total	integer	Optional

Responses

200✅

422⚠️

Code Examples

curl --location --globoff 'https://api.bayut.com/v1/leads?channel=website&target=listing&type=story&agency_ids[]=&created_from=2025-10-01&created_to=2025-10-08&page=1&per_page=50' \
--header 'Authorization: Bearer <token>'

{
    "data": [
        {
            "lead": {
                "id": "phone|80e296c6-bd02-4234-a9ba-2a6358f3f118",
                "source": "bayut",
                "target": "listing",
                "channel": "website",
                "date_time": "2025-09-27 15:42:04"
            },
            "agent_details": {
                "url": "https://www.bayut.com/brokers/john-991434.html",
                "name": "John Doe",
                "email": "john.h@example.com",
                "phone": "+972111111111",
                "proxy_number": "+9721111111"
            },
            "inquirer_details": {
                "name": "",
                "cell": "+9713333333",
                "email": "",
                "message": ""
            },
            "story_details": {
                "id": 8195,
                "listing_details": {
                    "id": 12635740,
                    "reference": "DPB-R-1697",
                    "category": "Apartment",
                    "url": "https://www.bayut.com/to-rent/apartments/dubai/jumeirah-village-circle-jvc/jvc-district-12/binghatti-nova/brand-new-fully-furnished-multiple-cheques-12635740.html, ru=>NULL, zh=>NULL"
                },
                "project_details": {
                    "name": "",
                    "name_ar": "",
                    "developer_name_en": "",
                    "developer_name_ar": "",
                    "property_types_name_en": "",
                    "property_types_name_ar": "",
                    "image_path": "",
                    "lpv_url_en": null,
                    "lpv_url_ar": null
                }
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "to": 1,
        "per_page": 1,
        "total": 11
    }
}