Offer Campaign APIs
Lead List API
The Campaign Lead List API retrieves a comprehensive list of leads linked to a particular campaign. This enables easy access to lead data for analysis, reporting, or follow-up tasks, ensuring campaign data is organized and accessible.
GET
cURL
Overview
The Lead List API returns a paginated list of leads associated with a specific offer campaign. Use it to pull lead records for reporting dashboards, data exports, CRM syncs, or campaign performance reviews. Results include lead details, status, source attribution, and timestamps.Endpoint
Authentication
Include your API token in theAuthorization header:
Request Parameters
Path Parameters
Query Parameters
Example Request
Example Response
Error — Invalid Campaign
Error — Unauthorized
Status Codes
Tips
- Pagination: Always use the
pageandlimitparameters when working with large campaigns to avoid timeouts. Start at page 1 and increment until you reach all records (totalRecord / limitpages). - Date filters: Use
fromandtotogether to pull leads for a specific reporting window. Both acceptYYYY-MM-DDformat and filter on the lead’s creation timestamp in UTC. - Source filtering: Use the
pidparameter to pull leads from a single source within a campaign — useful when comparing source performance. - Status filtering: Combine
leadStatus=acceptedwith date filters for accurate sold-lead counts without pulling rejected or duplicate records.