Leads

List campaign leads

Page through a campaign’s leads with filters (status, tags, search, engagement: opened / clicked / not opened).

Requires one of the following scopes: leads:read, leads:all, all:read, all:all.

get/v1/campaigns/{cid}/leads

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/campaigns/{cid}/leads
  • Auth: HTTP bearer

Path parameters

cidstring uuid required
Example:a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60

Query parameters

cursorstring
Example:eyJ0cyI6IjIwMjYtMDctMDJUMDA6MDA6MDAuMDAwWiIsImlkIjoiM2YxYzJiN2UtOWE0ZC00ZTE4LWIyYzEtNmQ4ZjVhMGU3YzkzIn0

Opaque cursor from a previous response’s meta.nextCursor. Omit for the first page. Results are ordered newest-first and stable under concurrent changes.

limitnumber
Example:50
searchstring
Example:acme

Match on email / first name / last name / company.

status'not_contacted' | 'scheduled' | 'email_sent' | 'failed' | 'skipped' | 'lead_replied_interested' | 'lead_replied_meeting_request' | 'lead_replied_out_of_office' | 'lead_replied_bounce' | 'lead_replied_wrong_person' | 'lead_replied_not_interested' | 'lead_replied_unsubscribed' | 'lead_replied_uncategorized' | 'lead_converted' | 'lead_lost' | 'blacklisted'

Filter by lead status.

tagsstring[]

Has ANY of these tags. Repeat the param (?tags=a&tags=b) or pass a single value.

[
  "vip",
  "q4"
]
engagement'opened' | 'opened_no_reply' | 'clicked' | 'not_opened'

Filter by engagement. opened — opened at least one email; opened_no_reply — opened and has not replied (any reply counts, out-of-office and auto-replies included); clicked — clicked a tracked link; not_opened — was sent at least one email with open tracking and opened none.

Response

Example response

{
  "data": [
    {
      "id": "c9e5b1a3-7f24-4d80-a6b9-2e4f8c0d1a37",
      "email": "jane@acme.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "companyName": "Acme Inc",
      "jobTitle": "VP Sales",
      "website": "https://acme.com",
      "linkedinProfile": "https://www.linkedin.com/in/janedoe",
      "location": "New York, US",
      "tags": [
        "vip",
        "q4"
      ],
      "customFields": {
        "industry": "SaaS"
      },
      "status": "not_contacted",
      "verification": {
        "status": "valid",
        "subStatus": "email_ok"
      },
      "provider": "google",
      "metrics": {
        "sent": 2,
        "opened": 1
      },
      "sequenceProgress": {
        "totalSteps": 3,
        "sentCount": 1,
        "plannedCount": 1
      }
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "eyJ0cyI6IjIwMjYtMDctMDJUMDA6MDA6MDAuMDAwWiIsImlkIjoiM2YxYzJiN2UtOWE0ZC00ZTE4LWIyYzEtNmQ4ZjVhMGU3YzkzIn0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.