SmartLead icon

SmartLead

Interact with SmartLead API (campaigns, leads, inbox, analytics, delivery, and webhooks)

Actions144

Lead → List by Campaign

AI-generated

Summary

List leads in a campaign

Inputs

  • campaignId (required) — Identifier of the campaign to list leads for
  • returnAll — Whether to return all results or only up to a given limit
  • limit — Maximum number of leads to return per page
  • pageSize — Number of items per page when using pagination
  • offset — Offset for pagination (starting index)
  • queryParameters — Additional query‑string parameters supplied as a JSON object

Output shape

Array of lead objects

Paginated; use limit, pageSize, offset; default limit 50; if returnAll is false only up to limit results are returned; otherwise all pages are fetched until all leads are returned.

Examples

Example 1: Retrieve leads for a specific campaign

Set Operation to List by Campaign, Campaign ID to 12345, leave other defaults

Example 2: Fetch all leads for a campaign

Set Operation to List by Campaign, Campaign ID to 9876, enable Return All true, optionally increase Page Size

Example 3: Get a limited subset of active leads

Set Operation to List by Campaign, Campaign ID to 5555, queryParameters to {"status":"active"}, limit to 10

Links

Discussion