GetLeadsFromList | HeyReach API Documentation

curl -X POST https://api/api/public/list/GetLeadsFromList \
     -H "X-API-KEY: <string>" \
     -H "Content-Type: application/json" \
     -d '{
  "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"
}'

{
  "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>"
        }
      ]
    }
  ]
}

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/’
leadLinkedInId (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.

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.

Request

This endpoint expects an object.

listIdintegerRequired

offsetintegerRequired

keywordstringRequired

leadProfileUrlstringRequiredformat: "uri"

leadLinkedInIdstringRequired

limitintegerRequired

createdFromdatetimeRequired

createdTodatetimeRequired

Response

totalCountstring

itemslist of objects

Errors

400

Get Leads from List Lists Request Bad Request Error

401

Get Leads from List Lists Request Unauthorized Error

404

Get Leads from List Lists Request Not Found Error

429

Get Leads from List Lists Request Too Many Requests Error

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/’
leadLinkedInId (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.

Headers

Request

Response

Errors