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

# GetLeadsFromList

POST https://api//api/public/list/GetLeadsFromList
Content-Type: application/json

Get a paginated collection of leads from a lead list. Get up to 1000 leads per request.

- **listId:** The id of the lead list.
    
- **keyword (optional)**: A search term to filter leads by name or other relevant fields.
    
- **leadProfileUrl (optional)**: the linkedIn profile url of the lead, for example '[https://www.linkedin.com/in/john-doe/'](https://www.linkedin.com/in/john-doe/')
    
- l**eadLinkedInId (string, optional)**: The LinkedIn ID of the lead. You can find this ID as "linkedin_id" in the response of many of our endpoints, for example in the '/api/public/lead/GetLead' endpoint.
    
- **createdFrom** _(string, ISO 8601)_: Specifies the start date and time for filtering leads based on their creation timestamp. Only leads created on or after this date will be included. Can be ommited.
    
- **createdTo** _(string, ISO 8601)_: Specifies the end date and time for filtering leads based on their creation timestamp. Only leads created before or at this date will be included. Can be ommited.

Reference: https://docs.heyreach.io/hey-reach-api/lists/get-leads-from-list

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

- `listId` (integer, required)
- `offset` (integer, required)
- `keyword` (string, required)
- `leadProfileUrl` (string, required)
- `leadLinkedInId` (string, required)
- `limit` (integer, required)
- `createdFrom` (datetime, required)
- `createdTo` (datetime, required)

## Response

### 200

OK

- `totalCount` (string, required)
- `items` (list of object, required)
  - `profileUrl` (string, required)
  - `firstName` (string, required)
  - `lastName` (string, required)
  - `headline` (string, required)
  - `imageUrl` (string, required)
  - `location` (string, required)
  - `companyName` (string, required)
  - `companyUrl` (string, required)
  - `position` (string, required)
  - `about` (string, required)
  - `connections` (string, required)
  - `followers` (string, required)
  - `tags` (list of string, required)
  - `emailAddress` (string, required)
  - `customFields` (list of object, required)
    - `name` (string, required)
    - `value` (string, required)

## Errors

### 400 Get Leads from List Lists Request Bad Request Error

Bad Request

- `errorMessage` (string, required)

### 401 Get Leads from List Lists Request Unauthorized Error

Unauthorized

- `type` (string, required)
- `title` (string, required)
- `status` (string, required)
- `detail` (string, required)
- `instance` (string, required)
- `ut8c` (object, required)
- `laborum__e5` (object, required)
- `occaecat100` (object, required)

### 404 Get Leads from List Lists Request Not Found Error

Not Found

- `errorMessage` (string, required)

### 429 Get Leads from List Lists Request Too Many Requests Error

Too Many Requests

- `type` (string, required)
- `title` (string, required)
- `status` (string, required)
- `detail` (string, required)
- `instance` (string, required)
- `ut8c` (object, required)
- `laborum__e5` (object, required)
- `occaecat100` (object, required)

## Examples

**Request**

```json
{
  "listId": 123,
  "offset": 0,
  "keyword": "",
  "leadProfileUrl": "https://www.linkedin.com/in/john-doe/",
  "leadLinkedInId": "121313fsdf234",
  "limit": 10,
  "createdFrom": "2024-10-06T15:34:00Z",
  "createdTo": "2024-10-07T15:34:00Z"
}
```

**Response**

```json
{
  "totalCount": "<integer>",
  "items": [
    {
      "profileUrl": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "headline": "<string>",
      "imageUrl": "<string>",
      "location": "<string>",
      "companyName": "<string>",
      "companyUrl": "<string>",
      "position": "<string>",
      "about": "<string>",
      "connections": "<integer>",
      "followers": "<integer>",
      "tags": [
        "<string>",
        "<string>"
      ],
      "emailAddress": "<string>",
      "customFields": [
        {
          "name": "<string>",
          "value": "<string>"
        },
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    },
    {
      "profileUrl": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "headline": "<string>",
      "imageUrl": "<string>",
      "location": "<string>",
      "companyName": "<string>",
      "companyUrl": "<string>",
      "position": "<string>",
      "about": "<string>",
      "connections": "<integer>",
      "followers": "<integer>",
      "tags": [
        "<string>",
        "<string>"
      ],
      "emailAddress": "<string>",
      "customFields": [
        {
          "name": "<string>",
          "value": "<string>"
        },
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api//api/public/list/GetLeadsFromList"

payload = {
    "listId": 123,
    "offset": 0,
    "keyword": "",
    "leadProfileUrl": "https://www.linkedin.com/in/john-doe/",
    "leadLinkedInId": "121313fsdf234",
    "limit": 10,
    "createdFrom": "2024-10-06T15:34:00Z",
    "createdTo": "2024-10-07T15:34:00Z"
}
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/list/GetLeadsFromList';
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<string>', 'Content-Type': 'application/json'},
  body: '{"listId":123,"offset":0,"keyword":"","leadProfileUrl":"https://www.linkedin.com/in/john-doe/","leadLinkedInId":"121313fsdf234","limit":10,"createdFrom":"2024-10-06T15:34:00Z","createdTo":"2024-10-07T15:34:00Z"}'
};

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/list/GetLeadsFromList"

	payload := strings.NewReader("{\n  \"listId\": 123,\n  \"offset\": 0,\n  \"keyword\": \"\",\n  \"leadProfileUrl\": \"https://www.linkedin.com/in/john-doe/\",\n  \"leadLinkedInId\": \"121313fsdf234\",\n  \"limit\": 10,\n  \"createdFrom\": \"2024-10-06T15:34:00Z\",\n  \"createdTo\": \"2024-10-07T15:34:00Z\"\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/list/GetLeadsFromList")

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  \"listId\": 123,\n  \"offset\": 0,\n  \"keyword\": \"\",\n  \"leadProfileUrl\": \"https://www.linkedin.com/in/john-doe/\",\n  \"leadLinkedInId\": \"121313fsdf234\",\n  \"limit\": 10,\n  \"createdFrom\": \"2024-10-06T15:34:00Z\",\n  \"createdTo\": \"2024-10-07T15:34:00Z\"\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/list/GetLeadsFromList")
  .header("X-API-KEY", "<string>")
  .header("Content-Type", "application/json")
  .body("{\n  \"listId\": 123,\n  \"offset\": 0,\n  \"keyword\": \"\",\n  \"leadProfileUrl\": \"https://www.linkedin.com/in/john-doe/\",\n  \"leadLinkedInId\": \"121313fsdf234\",\n  \"limit\": 10,\n  \"createdFrom\": \"2024-10-06T15:34:00Z\",\n  \"createdTo\": \"2024-10-07T15:34:00Z\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api//api/public/list/GetLeadsFromList', [
  'body' => '{
  "listId": 123,
  "offset": 0,
  "keyword": "",
  "leadProfileUrl": "https://www.linkedin.com/in/john-doe/",
  "leadLinkedInId": "121313fsdf234",
  "limit": 10,
  "createdFrom": "2024-10-06T15:34:00Z",
  "createdTo": "2024-10-07T15:34:00Z"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-KEY' => '<string>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api//api/public/list/GetLeadsFromList");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-KEY", "<string>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"listId\": 123,\n  \"offset\": 0,\n  \"keyword\": \"\",\n  \"leadProfileUrl\": \"https://www.linkedin.com/in/john-doe/\",\n  \"leadLinkedInId\": \"121313fsdf234\",\n  \"limit\": 10,\n  \"createdFrom\": \"2024-10-06T15:34:00Z\",\n  \"createdTo\": \"2024-10-07T15:34:00Z\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-API-KEY": "<string>",
  "Content-Type": "application/json"
]
let parameters = [
  "listId": 123,
  "offset": 0,
  "keyword": "",
  "leadProfileUrl": "https://www.linkedin.com/in/john-doe/",
  "leadLinkedInId": "121313fsdf234",
  "limit": 10,
  "createdFrom": "2024-10-06T15:34:00Z",
  "createdTo": "2024-10-07T15:34:00Z"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api//api/public/list/GetLeadsFromList")! 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()
```