List ZapSite Leads

GET

/zap-sites/{id}/leads

Use this to power a leads inbox for the customer. It lists every lead this ZapSite's on-page form has captured, newest first, across all its deployments. Updated in real time as leads come in, so this never calls upstream.

Test alerts (POST /:id/test-alert) are excluded by default, pass includeTests=true to see them too.

Example

GET /zap-sites/SITECCHMN86W734P8PMM3E53EW82HCC2/leads?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM&page=1&limit=50

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Path Params

Query Params

Responses

🟢200Success

application/json

Leads fetched successfully

Bodyapplication/json

🟠401Unauthorized

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/zap-sites/SITECCHMN86W734P8PMM3E53EW82HCC2/leads?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM&page=1&limit=50&includeTests=false' \
--header 'cmr-x-api-key: <api-key>'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Leads fetched successfully",
    "data": [
        {
            "id": "string",
            "fields": {},
            "domain": "string",
            "referrer": "string",
            "isTest": true,
            "createdAt": "string"
        }
    ],
    "pagination": {
        "totalSearchedCount": 0,
        "currentPage": 0,
        "nextPage": 0,
        "totalPages": 0
    }
}

Modified at 2026-10-21 17:27:47

Preview ZapSite

Send Test Lead Alert

List ZapSite Leads

Example#

Request

Responses

Example