GetCompaniesFromList | HeyReach API Documentation

curl -X POST https://api/api/public/list/GetCompaniesFromList \
     -H "X-API-KEY: <string>" \
     -H "Content-Type: application/json" \
     -d '{
  "listId": 123,
  "offset": 0,
  "keyword": "HeyReach",
  "limit": 10
}'

{
  "totalCount": "<integer>",
  "items": [
    {
      "name": "<string>",
      "description": "<string>",
      "industry": "<string>",
      "imageUrl": "<string>",
      "companySize": "<string>",
      "employeesOnLinkedIn": "<integer>",
      "location": "<string>",
      "specialities": "<string>",
      "website": "<string>"
    },
    {
      "name": "<string>",
      "description": "<string>",
      "industry": "<string>",
      "imageUrl": "<string>",
      "companySize": "<string>",
      "employeesOnLinkedIn": "<integer>",
      "location": "<string>",
      "specialities": "<string>",
      "website": "<string>"
    }
  ]
}

Get a paginated collection of companies from a company list. Get up to 1000 companies per request.

Request

This endpoint expects an object.

listIdintegerRequired

offsetintegerRequired

keywordstringRequired

limitintegerRequired

Response

totalCountstring

itemslist of objects

Errors

400

Get Companies from List Lists Request Bad Request Error

401

Get Companies from List Lists Request Unauthorized Error

404

Get Companies from List Lists Request Not Found Error

429

Get Companies from List Lists Request Too Many Requests Error

Headers

Request

Response

Errors