> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.heyreach.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.heyreach.io/_mcp/server.

# GetLeads

POST https://api//api/public/blacklist/GetLeads
Content-Type: application/json

Get a paginated collection of the blacklisted leads in your workspace, newest first. The blacklist is workspace-scoped - each workspace keeps its own, and an API key only ever sees its own workspace's entries.

- **offset** _(optional)_: the number of entries to skip. Defaults to `0`.
    
- **limit** _(optional)_: the page size, between `1` and `100`. Defaults to `10`.
    
- **search** _(optional)_: a case-insensitive substring match on name, email, profile URL and LinkedIn member id.
    
- **matchingStatus** _(optional)_: filter by how the entry resolved. One of:
    
    - `Matching` - still resolving: a URL awaiting enrichment, or an email awaiting reverse lookup.
        
    - `Matched` - resolved to a LinkedIn profile. Excludes that exact person.
        
    - `NotFound` - the URL or email resolved to nothing. Excludes nobody.
        
    - `BroadMatch` - a name-only entry. Nothing to resolve; excludes by exact name comparison.
        

Each item also carries **resolutionStage** and **resolutionError**, a finer-grained diagnostic view of the same resolution - use them to tell an entry waiting on the email lookup from one whose profile enrichment failed.

**resolutionStage** is one of `AwaitingProfileEnrichment`, `ProfileEnrichmentNoData`, `ProfileEnrichmentFailed`, `AwaitingReverseLookup`, `ReverseLookupNotEnabled`, `ReverseLookupNoProfile`, `NotResolvable` or `Resolved`. A name-only entry goes straight to `NotResolvable`. An email-only entry goes to `AwaitingReverseLookup` when the workspace has reverse lookup enabled and `ReverseLookupNotEnabled` when it does not, settling on `Resolved` or `ReverseLookupNoProfile` once the lookup returns. **resolutionError** carries a human-readable reason when resolution failed, and is null otherwise.

**matchingStatus** and **resolutionStage** are returned as strings.

Reference: https://docs.heyreach.io/hey-reach-api/blacklist/get-leads

## Request

### Headers

- `X-API-KEY` (string, optional) — API key header using this scheme. Example: "X-API-KEY: \{API\_KEY}"

### Body (application/json)

This endpoint expects an object.

- `offset` (integer, required)
- `limit` (integer, required)
- `search` (string, required)
- `matchingStatus` (string, required)

## Response

### 200

OK

- `totalCount` (string, required)
- `items` (list of object, required)
  - `id` (string, required)
  - `profileUrl` (string, required)
  - `email` (string, required)
  - `fullName` (string, required)
  - `imageUrl` (string, required)
  - `companyName` (string, required)
  - `position` (string, required)
  - `linkedInProfileId` (string, required)
  - `matchingStatus` (string, required)
  - `resolutionStage` (string, required)
  - `creationTime` (datetime, required)
  - `resolutionError` (any, optional, nullable)

## Examples

**Request**

```json
{
  "offset": 0,
  "limit": 20,
  "search": "john",
  "matchingStatus": "Matched"
}
```

**Response**

```json
{
  "totalCount": "<integer>",
  "items": [
    {
      "id": "<long>",
      "profileUrl": "<string>",
      "email": "<string>",
      "fullName": "<string>",
      "imageUrl": "<string>",
      "companyName": "<string>",
      "position": "<string>",
      "linkedInProfileId": "<string>",
      "matchingStatus": "Matched",
      "resolutionStage": "Resolved",
      "creationTime": "2026-09-16T12:00:00Z"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api//api/public/blacklist/GetLeads"

payload = {
    "offset": 0,
    "limit": 20,
    "search": "john",
    "matchingStatus": "Matched"
}
headers = {
    "X-API-KEY": "<string>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api//api/public/blacklist/GetLeads';
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<string>', 'Content-Type': 'application/json'},
  body: '{"offset":0,"limit":20,"search":"john","matchingStatus":"Matched"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api//api/public/blacklist/GetLeads"

	payload := strings.NewReader("{\n  \"offset\": 0,\n  \"limit\": 20,\n  \"search\": \"john\",\n  \"matchingStatus\": \"Matched\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<string>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api//api/public/blacklist/GetLeads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<string>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"offset\": 0,\n  \"limit\": 20,\n  \"search\": \"john\",\n  \"matchingStatus\": \"Matched\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api//api/public/blacklist/GetLeads")
  .header("X-API-KEY", "<string>")
  .header("Content-Type", "application/json")
  .body("{\n  \"offset\": 0,\n  \"limit\": 20,\n  \"search\": \"john\",\n  \"matchingStatus\": \"Matched\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api//api/public/blacklist/GetLeads', [
  'body' => '{
  "offset": 0,
  "limit": 20,
  "search": "john",
  "matchingStatus": "Matched"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-KEY' => '<string>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api//api/public/blacklist/GetLeads");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-KEY", "<string>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"offset\": 0,\n  \"limit\": 20,\n  \"search\": \"john\",\n  \"matchingStatus\": \"Matched\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-API-KEY": "<string>",
  "Content-Type": "application/json"
]
let parameters = [
  "offset": 0,
  "limit": 20,
  "search": "john",
  "matchingStatus": "Matched"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api//api/public/blacklist/GetLeads")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```