Skip to main content
GET
/
v1
/
blocked-leads
Get Workspace Blocked Leads
curl --request GET \
  --url https://app-api.walead.ai/api/v1/blocked-leads \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "publicIdentifier": "<string>",
    "reason": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "workspaceId": "<string>"
  }
]

​
Overview

Retrieves the list of blocked leads at the workspace level. This endpoint returns all LinkedIn profiles that have been blocked across all campaigns in your workspace.

​
Use Cases

  • Audit Global Block List: Review all contacts blocked at workspace level
  • Export Compliance List: Download the complete list of blocked leads for record-keeping
  • Search Blocked Contacts: Find specific leads in your workspace blocked list
  • Monitor Block List: Track and manage your workspace-wide exclusion list

​
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

curl -X GET https://app-api.walead.ai/api/v1/blocked-leads \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

​
Request Details

This endpoint requires an API key for authentication and supports sorting, pagination, and search functionality.

​
Query Parameters

  • sort (optional): Sort order for results - ASC or DESC (default: DESC)
  • offset (optional): Number of records to skip for pagination (default: 0)
  • search (optional): Search term to filter blocked leads by public identifier

​
Response

The response includes an array of blocked leads with their details:
  • id: Unique identifier of the blocked lead record
  • 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
  • workspaceId: The workspace this block applies to

​
Important Notes

  • This endpoint requires API key authentication
  • Results can be filtered using the search parameter
  • Use offset parameter to navigate through large lists of blocked leads
  • Workspace-level blocked leads apply to all campaigns in the workspace
  • Sorting by date helps identify recently blocked contacts

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate from your WaLead dashboard.

Query Parameters

​
sort
enum<string>
default:DESC

Sort order for results

Available options:
ASC,
DESC
​
offset
integer
default:0

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

​
search
string

Search term to filter blocked leads by public identifier

Response

Blocked leads retrieved successfully

​
id
string

Unique identifier of the blocked lead record

​
publicIdentifier
string

LinkedIn public identifier

​
reason
string | null

Reason for blocking

​
createdAt
string<date-time>

Timestamp when the lead was blocked

​
workspaceId
string

Workspace ID