Skip to main content
GET
/
api
/
v1
/
leads
List all Leads
curl --request GET \
  --url https://api.example.com/api/v1/leads/
{
  "data": [
    {
      "uid": "<string>",
      "contact": {
        "id": 123,
        "email_id": "<string>",
        "bounced": true,
        "unsubscribed": true
      },
      "schedules": [
        {
          "id": 123,
          "email_data": {
            "id": 123,
            "subject": "<string>",
            "body": "<string>",
            "email_content_type": "text/plain"
          },
          "link_click_events": [
            {
              "id": 123,
              "link": "<string>",
              "clicked_on": "2023-11-07T05:31:56Z"
            }
          ],
          "replies": [
            {
              "id": 123,
              "body_plain_text": "<string>",
              "body_html": "<string>",
              "received_on": "2023-11-07T05:31:56Z",
              "reply_classification": "positive"
            }
          ],
          "status": "created",
          "schedule_datetime": "2023-11-07T05:31:56Z",
          "sent_on": "2023-11-07T05:31:56Z",
          "reply_received": true,
          "email_opened": true,
          "email_opened_on": "2023-11-07T05:31:56Z",
          "email_open_count": 1073741823
        }
      ],
      "sender_email_address": "<string>",
      "sender_name": "<string>"
    }
  ],
  "total": 123
}

Query Parameters

campaign_uid
integer
required

UID of the campaign whose leads data to fetch.

limit
integer
required

Number of results to fetch (min: 1, max: 100, default: 100)

offset
integer
required

Starting index for fetching data (min: 0, default: 0)

Response

Success

data
object[]
required
total
integer
required