← Home
Get Phone Call Leads
Get Phone Call Leads
Retrieves leads received through Phone.The is_lead parameter determines whether to fetch actual leads or view (non-lead) inquiries within the specified 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., email). | phone |
| is_lead | boolean | Optional | 1 = Fetch actual leads, 0 = Fetch view (non-lead) inquiries. | 1 |
| 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 | Description | Example |
|---|---|---|---|---|
| data | array[object] | Optional | ||
| lead | object | Optional | ||
| call_details | object | Optional | ||
| inquirer_details | object | Optional | ||
| agent_details | object | Optional | ||
| agency_details | object | Optional | ||
| listing_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=phone&is_lead=1&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|b320a3db-9b84-4ff8-94ba-9106a9363779",
"source": "bayut",
"target": null,
"channel": "phone",
"date_time": "2025-11-03 10:12:07"
},
"call_details": {
"status": "connected",
"type": null,
"total_duration": "00:00:31",
"connected_duration": "00:00:05",
"time": null,
"pickup_time": null,
"recording_url": "https://api.bayut.com/api-v7/website-leads/recordings?key=def5020085aaaa28e8e85a00ab1e8b769d53de79949a1950a7c260caf60425175dc75a94fc5024a4c3164488d5847e3835b9b8490eb664ca3f0a06ea57a27c8cddefa5a8d42fdc5bffb09112e63d241afee912fb3312ca2dddcce5a7404bad7a9df7e3ae2045b342aa286ce5ab6118f726e0ad798d2fc36cea2d9d19317df0820082cc12089874e48f2442a024e764f8f6a2e1d4cd9fe172252c66269080d299566b27828ecbdc68f22fd18518ef488fc6964928fb69ce3df97fdeba4583588ca0958b03ce4eda9f72c04e",
"source": null,
"caller_location": null,
"proxy_number": "+971333333",
"receiver_numbers_list": "",
"receiver_number": "+9712222222",
"callback": {
"status": "connected",
"date_time": "2025-11-03 10:16:18",
"recording_url": "https://api.bayut.com/api-v7/website-leads/recordings?key=def5020085aaaa28e8e85a00ab1e8b769d53de79949a1950a7c260caf60425175dc75a94fc5024a4c3164488d5847e3835b9b8490eb664ca3f0a06ea57a27c8cddefa5a8d42fdc5bffb09112e63d241afee912fb3312ca2dddcce5a7404bad7a9df7e3ae2045b342aa286ce5ab6118f726e0ad798d2fc36cea2d9d19317df0820082cc12089874e48f2442a024e764f8f6a2e1d4cd9fe172252c66269080d299566b27828ecbdc68f22fd18518ef488fc6964928fb69ce3df97fdeba4583588ca0958b03ce4eda9f72c04e",
"duration": 141,
"total_duration": 169
}
},
"inquirer_details": {
"name": "",
"cell": "+1223333333",
"email": "",
"message": ""
},
"agent_details": {
"url": "https://www.bayut.com/brokers/jane-doe-333.html",
"name": "Jane Doe",
"email": "jane.doe@example.com",
"phone": "+9713333333",
"proxy_number": "+9713333333"
},
"agency_details": {
"url": "https://www.bayut.com/companies/test-properties/",
"name": "Test Properties"
},
"listing_details": {
"id": 12656006,
"reference": "DP-R-56398",
"category": "Apartment"
}
}
],
"meta": {
"current_page": 1,
"from": 1,
"to": 1,
"per_page": 50,
"total": 2
}
}