List the leads submitted against a WhatsApp number.

GET

https://api.sudonum.com.com/v2/whatsapp/lead/{waba_id}

Returns the leads submitted against this WhatsApp number, newest first, in pages. Every filter is optional, and filters combine with AND.

start_date on its own returns everything from that date onward. end_date on its own is ignored — pair it with start_date to bound a range.

Request

Path Params

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

A page of leads.

Bodyapplication/json

Example

{
    "count": 42,
    "next": "http://example.com",
    "previous": "http://example.com",
    "results": [
        {
            "uuid": "3f6a1c22-0000-4b00-8000-9c1d2e3f4a5b",
            "data": {
                "id": "5c9f2b41-0000-4a00-9000-1f0a2b3c4d5e",
                "enquirer": {},
                "listing": {
                    "reference_id": "REF-0001",
                    "url": "https://example.com/listings/REF-0001"
                },
                "meta_data": {
                    "source": "Portal",
                    "enquiry_type": "Sales"
                },
                "extra_variable_data": {
                    "agent_name": "Sam Nkosi",
                    "Link": "https://example.com/listings/REF-0001"
                },
                "extra_info": {
                    "property1": "string",
                    "property2": "string"
                },
                "notify_delay": 60,
                "reply_delay": 30,
                "aparty_notify_whatsapp_template_name": "lead_conversation_start",
                "aparty_notify_whatsapp_template_components": []
            },
            "whatsapp_number": "27820000001",
            "created": "2026-08-20T09:14:52.418000Z"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠429Too Many Requests

Modified at 2026-08-31 07:42:46

Submit WhatsApp number.

Start a chat intro