> ## Documentation Index
> Fetch the complete documentation index at: https://docs.walead.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Workspace Blocked Leads

> 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.

## 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

```bash theme={null}
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


## OpenAPI

````yaml GET /v1/blocked-leads
openapi: 3.1.0
info:
  title: WaLead API
  description: >-
    WaLead Public API for managing LinkedIn outreach campaigns, leads, and
    analytics
  version: 1.0.0
  contact:
    name: WaLead Support
    url: https://walead.ai
servers:
  - url: https://app-api.walead.ai/api
    description: Production server
security:
  - apiKeyAuth: []
paths:
  /v1/blocked-leads:
    get:
      summary: Get Workspace Blocked Leads
      description: >-
        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.
      parameters:
        - name: sort
          in: query
          description: Sort order for results
          schema:
            type: string
            enum:
              - ASC
              - DESC
            default: DESC
        - name: offset
          in: query
          description: 'Number of records to skip for pagination (default: 0)'
          schema:
            type: integer
            default: 0
        - name: search
          in: query
          description: Search term to filter blocked leads by public identifier
          schema:
            type: string
      responses:
        '200':
          description: Blocked leads retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Unique identifier of the blocked lead record
                    publicIdentifier:
                      type: string
                      description: LinkedIn public identifier
                    reason:
                      type: string
                      nullable: true
                      description: Reason for blocking
                    createdAt:
                      type: string
                      format: date-time
                      description: Timestamp when the lead was blocked
                    workspaceId:
                      type: string
                      description: Workspace ID
        '401':
          description: Unauthorized - Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Error message
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Generate from your WaLead dashboard.

````