Skip to main content
GET
Get Campaign Blocked Leads

Overview

Retrieves the list of blocked leads for a specific campaign. This endpoint returns all LinkedIn profiles that have been blocked from receiving messages in this campaign.

Use Cases

  • Audit Blocked Contacts: Review which leads have been blocked in your campaign
  • Export Blocked List: Get a list of all blocked contacts for reporting purposes
  • Verification: Confirm that specific leads have been successfully blocked

Authentication

All requests require an API key passed in the x-api-key header. You can generate your API key from the WaLead dashboard.

Example Request

Request Details

This endpoint requires an API key for authentication and supports pagination through optional query parameters.

Query Parameters

  • skip (optional): Number of records to skip for pagination (default: 0)
  • take (optional): Number of records to return (default: 10, max: 100)

Response

The response includes an array of blocked leads with their details:
  • publicIdentifier: The LinkedIn public identifier of the blocked lead
  • reason: Optional reason for blocking (if provided when blocking)
  • createdAt: Timestamp when the lead was blocked

Important Notes

  • This endpoint requires API key authentication
  • Results are paginated to optimize performance
  • Use skip and take parameters to navigate through large lists of blocked leads
  • Blocked leads in a campaign are specific to that campaign only

Authorizations

x-api-key
string
header
required

API key for authentication. Generate from your WaLead dashboard.

Path Parameters

campaignId
string
required

Campaign ID

Query Parameters

skip
integer
default:0

Number of records to skip for pagination (default: 0)

take
integer
default:10

Number of records to return (default: 10, max: 100)

Required range: x <= 100

Response

Blocked leads retrieved successfully

publicIdentifier
string

LinkedIn public identifier

reason
string | null

Reason for blocking

createdAt
string<date-time>

Timestamp when the lead was blocked