Scroll

curl --request POST \
  --url https://api.companyenrich.com/companies/search/scroll \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": 50,
  "cursor": "<string>",
  "lists": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "semanticQuery": "<string>",
  "semanticWeight": 0.5,
  "exclude": {
    "domains": [
      "<string>"
    ],
    "regions": [
      "<string>"
    ],
    "countries": [
      "<string>"
    ],
    "states": [
      123
    ],
    "cities": [
      123
    ],
    "type": [],
    "category": [],
    "employees": [],
    "reportedEmployees": [],
    "revenue": [],
    "naicsCode": [
      123
    ],
    "keywords": [
      "<string>"
    ],
    "technologies": [
      "<string>"
    ],
    "fundingRounds": []
  },
  "query": "<string>",
  "foundedYear": {
    "min": 123,
    "max": 123
  },
  "fundingAmount": {
    "min": 123,
    "max": 123
  },
  "fundingYear": {
    "min": 123,
    "max": 123
  },
  "workforceGrowth": {
    "minPercent": 123,
    "maxPercent": 123
  },
  "workforceSize": [
    {
      "min": 123,
      "max": 123
    }
  ],
  "require": [],
  "regions": [
    "<string>"
  ],
  "countries": [
    "<string>"
  ],
  "states": [
    123
  ],
  "cities": [
    123
  ],
  "type": [],
  "category": [],
  "employees": [],
  "reportedEmployees": [],
  "revenue": [],
  "naicsCode": [
    123
  ],
  "keywords": [
    "<string>"
  ],
  "technologies": [
    "<string>"
  ],
  "fundingRounds": []
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pageSize: 50,
    cursor: '<string>',
    lists: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    semanticQuery: '<string>',
    semanticWeight: 0.5,
    exclude: {
      domains: ['<string>'],
      regions: ['<string>'],
      countries: ['<string>'],
      states: [123],
      cities: [123],
      type: [],
      category: [],
      employees: [],
      reportedEmployees: [],
      revenue: [],
      naicsCode: [123],
      keywords: ['<string>'],
      technologies: ['<string>'],
      fundingRounds: []
    },
    query: '<string>',
    foundedYear: {min: 123, max: 123},
    fundingAmount: {min: 123, max: 123},
    fundingYear: {min: 123, max: 123},
    workforceGrowth: {minPercent: 123, maxPercent: 123},
    workforceSize: [{min: 123, max: 123}],
    require: [],
    regions: ['<string>'],
    countries: ['<string>'],
    states: [123],
    cities: [123],
    type: [],
    category: [],
    employees: [],
    reportedEmployees: [],
    revenue: [],
    naicsCode: [123],
    keywords: ['<string>'],
    technologies: ['<string>'],
    fundingRounds: []
  })
};

fetch('https://api.companyenrich.com/companies/search/scroll', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.companyenrich.com/companies/search/scroll"

payload = {
    "pageSize": 50,
    "cursor": "<string>",
    "lists": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "semanticQuery": "<string>",
    "semanticWeight": 0.5,
    "exclude": {
        "domains": ["<string>"],
        "regions": ["<string>"],
        "countries": ["<string>"],
        "states": [123],
        "cities": [123],
        "type": [],
        "category": [],
        "employees": [],
        "reportedEmployees": [],
        "revenue": [],
        "naicsCode": [123],
        "keywords": ["<string>"],
        "technologies": ["<string>"],
        "fundingRounds": []
    },
    "query": "<string>",
    "foundedYear": {
        "min": 123,
        "max": 123
    },
    "fundingAmount": {
        "min": 123,
        "max": 123
    },
    "fundingYear": {
        "min": 123,
        "max": 123
    },
    "workforceGrowth": {
        "minPercent": 123,
        "maxPercent": 123
    },
    "workforceSize": [
        {
            "min": 123,
            "max": 123
        }
    ],
    "require": [],
    "regions": ["<string>"],
    "countries": ["<string>"],
    "states": [123],
    "cities": [123],
    "type": [],
    "category": [],
    "employees": [],
    "reportedEmployees": [],
    "revenue": [],
    "naicsCode": [123],
    "keywords": ["<string>"],
    "technologies": ["<string>"],
    "fundingRounds": []
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "domain": "<string>",
      "website": "<string>",
      "type": "unknown",
      "legalName": "<string>",
      "industry": "<string>",
      "industries": [
        "<string>"
      ],
      "categories": [
        "b2b"
      ],
      "employees": "1-10",
      "reported_employees": "1-10",
      "revenue": "under-1m",
      "description": "<string>",
      "keywords": [
        "<string>"
      ],
      "technologies": [
        "<string>"
      ],
      "subsidiaries": [
        "<string>"
      ],
      "founded_year": 123,
      "naics_codes": [
        "<string>"
      ],
      "location": {
        "country": {
          "code": "<string>",
          "name": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "state": {
          "id": 123,
          "name": "<string>",
          "code": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "city": {
          "id": 123,
          "name": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "address": "<string>",
        "postal_code": "<string>",
        "phone": "<string>"
      },
      "financial": {
        "stock_symbol": "<string>",
        "stock_exchange": "<string>",
        "total_funding": 123,
        "funding_stage": "<string>",
        "funding_date": "2023-11-07T05:31:56Z",
        "funding": [
          {
            "date": "2023-11-07T05:31:56Z",
            "amount": "<string>",
            "type": "<string>",
            "url": "<string>",
            "from": "<string>"
          }
        ]
      },
      "socials": {
        "linkedin_url": "<string>",
        "linkedin_id": "<string>",
        "twitter_url": "<string>",
        "facebook_url": "<string>",
        "instagram_url": "<string>",
        "angellist_url": "<string>",
        "crunchbase_url": "<string>",
        "youtube_url": "<string>",
        "github_url": "<string>",
        "g2_url": "<string>"
      },
      "page_rank": 123,
      "workforce": {
        "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "domain": "<string>",
        "department_headcount": {
          "c_suite": 123,
          "product_management": 123,
          "engineering_technical": 123,
          "design": 123,
          "education": 123,
          "finance": 123,
          "human_resources": 123,
          "information_technology": 123,
          "legal": 123,
          "marketing": 123,
          "medical_health": 123,
          "operations": 123,
          "sales": 123,
          "consulting": 123
        },
        "observed_employee_count": 123,
        "employee_count_range": "1-10",
        "unclassified_headcount": 123,
        "history": [
          {
            "date": "2023-12-25",
            "department_headcount": {
              "c_suite": 123,
              "product_management": 123,
              "engineering_technical": 123,
              "design": 123,
              "education": 123,
              "finance": 123,
              "human_resources": 123,
              "information_technology": 123,
              "legal": 123,
              "marketing": 123,
              "medical_health": 123,
              "operations": 123,
              "sales": 123,
              "consulting": 123
            },
            "observed_employee_count": 123,
            "employee_count_range": "1-10",
            "unclassified_headcount": 123
          }
        ]
      },
      "logo_url": "<string>",
      "seo_description": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "totalMatching": 123
  },
  "nextCursor": "<string>",
  "previousCursor": "<string>",
  "totalItems": 123,
  "startIndex": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Company · Search

Scroll

Cost: 1 credit per company returned. 1 credit minimum if no results are found.

Searches companies based on given criteria. You can search by name, domain, industry, employees, revenue, founded year, and more. At most 100 companies are returned per request.

You can request the next page of results by using the cursor parameter. The cursor is a string that encodes the current position in the result set. In case on no cursor is provided, the first page of results is returned. You can then use the next_cursor parameter to get the next page of results.

This will allow you to scroll over the results without having to keep track of the current page number and also allow paginating into more than 10.000 results.

POST

companies

scroll

Scroll

curl --request POST \
  --url https://api.companyenrich.com/companies/search/scroll \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": 50,
  "cursor": "<string>",
  "lists": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "semanticQuery": "<string>",
  "semanticWeight": 0.5,
  "exclude": {
    "domains": [
      "<string>"
    ],
    "regions": [
      "<string>"
    ],
    "countries": [
      "<string>"
    ],
    "states": [
      123
    ],
    "cities": [
      123
    ],
    "type": [],
    "category": [],
    "employees": [],
    "reportedEmployees": [],
    "revenue": [],
    "naicsCode": [
      123
    ],
    "keywords": [
      "<string>"
    ],
    "technologies": [
      "<string>"
    ],
    "fundingRounds": []
  },
  "query": "<string>",
  "foundedYear": {
    "min": 123,
    "max": 123
  },
  "fundingAmount": {
    "min": 123,
    "max": 123
  },
  "fundingYear": {
    "min": 123,
    "max": 123
  },
  "workforceGrowth": {
    "minPercent": 123,
    "maxPercent": 123
  },
  "workforceSize": [
    {
      "min": 123,
      "max": 123
    }
  ],
  "require": [],
  "regions": [
    "<string>"
  ],
  "countries": [
    "<string>"
  ],
  "states": [
    123
  ],
  "cities": [
    123
  ],
  "type": [],
  "category": [],
  "employees": [],
  "reportedEmployees": [],
  "revenue": [],
  "naicsCode": [
    123
  ],
  "keywords": [
    "<string>"
  ],
  "technologies": [
    "<string>"
  ],
  "fundingRounds": []
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pageSize: 50,
    cursor: '<string>',
    lists: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    semanticQuery: '<string>',
    semanticWeight: 0.5,
    exclude: {
      domains: ['<string>'],
      regions: ['<string>'],
      countries: ['<string>'],
      states: [123],
      cities: [123],
      type: [],
      category: [],
      employees: [],
      reportedEmployees: [],
      revenue: [],
      naicsCode: [123],
      keywords: ['<string>'],
      technologies: ['<string>'],
      fundingRounds: []
    },
    query: '<string>',
    foundedYear: {min: 123, max: 123},
    fundingAmount: {min: 123, max: 123},
    fundingYear: {min: 123, max: 123},
    workforceGrowth: {minPercent: 123, maxPercent: 123},
    workforceSize: [{min: 123, max: 123}],
    require: [],
    regions: ['<string>'],
    countries: ['<string>'],
    states: [123],
    cities: [123],
    type: [],
    category: [],
    employees: [],
    reportedEmployees: [],
    revenue: [],
    naicsCode: [123],
    keywords: ['<string>'],
    technologies: ['<string>'],
    fundingRounds: []
  })
};

fetch('https://api.companyenrich.com/companies/search/scroll', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.companyenrich.com/companies/search/scroll"

payload = {
    "pageSize": 50,
    "cursor": "<string>",
    "lists": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "semanticQuery": "<string>",
    "semanticWeight": 0.5,
    "exclude": {
        "domains": ["<string>"],
        "regions": ["<string>"],
        "countries": ["<string>"],
        "states": [123],
        "cities": [123],
        "type": [],
        "category": [],
        "employees": [],
        "reportedEmployees": [],
        "revenue": [],
        "naicsCode": [123],
        "keywords": ["<string>"],
        "technologies": ["<string>"],
        "fundingRounds": []
    },
    "query": "<string>",
    "foundedYear": {
        "min": 123,
        "max": 123
    },
    "fundingAmount": {
        "min": 123,
        "max": 123
    },
    "fundingYear": {
        "min": 123,
        "max": 123
    },
    "workforceGrowth": {
        "minPercent": 123,
        "maxPercent": 123
    },
    "workforceSize": [
        {
            "min": 123,
            "max": 123
        }
    ],
    "require": [],
    "regions": ["<string>"],
    "countries": ["<string>"],
    "states": [123],
    "cities": [123],
    "type": [],
    "category": [],
    "employees": [],
    "reportedEmployees": [],
    "revenue": [],
    "naicsCode": [123],
    "keywords": ["<string>"],
    "technologies": ["<string>"],
    "fundingRounds": []
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "domain": "<string>",
      "website": "<string>",
      "type": "unknown",
      "legalName": "<string>",
      "industry": "<string>",
      "industries": [
        "<string>"
      ],
      "categories": [
        "b2b"
      ],
      "employees": "1-10",
      "reported_employees": "1-10",
      "revenue": "under-1m",
      "description": "<string>",
      "keywords": [
        "<string>"
      ],
      "technologies": [
        "<string>"
      ],
      "subsidiaries": [
        "<string>"
      ],
      "founded_year": 123,
      "naics_codes": [
        "<string>"
      ],
      "location": {
        "country": {
          "code": "<string>",
          "name": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "state": {
          "id": 123,
          "name": "<string>",
          "code": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "city": {
          "id": 123,
          "name": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "address": "<string>",
        "postal_code": "<string>",
        "phone": "<string>"
      },
      "financial": {
        "stock_symbol": "<string>",
        "stock_exchange": "<string>",
        "total_funding": 123,
        "funding_stage": "<string>",
        "funding_date": "2023-11-07T05:31:56Z",
        "funding": [
          {
            "date": "2023-11-07T05:31:56Z",
            "amount": "<string>",
            "type": "<string>",
            "url": "<string>",
            "from": "<string>"
          }
        ]
      },
      "socials": {
        "linkedin_url": "<string>",
        "linkedin_id": "<string>",
        "twitter_url": "<string>",
        "facebook_url": "<string>",
        "instagram_url": "<string>",
        "angellist_url": "<string>",
        "crunchbase_url": "<string>",
        "youtube_url": "<string>",
        "github_url": "<string>",
        "g2_url": "<string>"
      },
      "page_rank": 123,
      "workforce": {
        "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "domain": "<string>",
        "department_headcount": {
          "c_suite": 123,
          "product_management": 123,
          "engineering_technical": 123,
          "design": 123,
          "education": 123,
          "finance": 123,
          "human_resources": 123,
          "information_technology": 123,
          "legal": 123,
          "marketing": 123,
          "medical_health": 123,
          "operations": 123,
          "sales": 123,
          "consulting": 123
        },
        "observed_employee_count": 123,
        "employee_count_range": "1-10",
        "unclassified_headcount": 123,
        "history": [
          {
            "date": "2023-12-25",
            "department_headcount": {
              "c_suite": 123,
              "product_management": 123,
              "engineering_technical": 123,
              "design": 123,
              "education": 123,
              "finance": 123,
              "human_resources": 123,
              "information_technology": 123,
              "legal": 123,
              "marketing": 123,
              "medical_health": 123,
              "operations": 123,
              "sales": 123,
              "consulting": 123
            },
            "observed_employee_count": 123,
            "employee_count_range": "1-10",
            "unclassified_headcount": 123
          }
        ]
      },
      "logo_url": "<string>",
      "seo_description": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "totalMatching": 123
  },
  "nextCursor": "<string>",
  "previousCursor": "<string>",
  "totalItems": 123,
  "startIndex": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

Authorization

string

header

required

API Token used for authentication. Example: "Authorization: Bearer {token}"

Query Parameters

expand

enum<string>[]

Expandable response fields. Repeat the parameter to request multiple expansions.

Supported values:

workforce: costs 5 credits per company and adds the workforce field to CompanyInfo.

Available options:

workforce

Body

application/json

pageSize

integer<int32>

The number of results to return in each page. Must be between 1 and 100

Required range: 1 <= x <= 100

cursor

string | null

The cursor to use for pagination. This is used for cursor based pagination. If this is set, Page will be ignored.

Maximum string length: 1024

lists

string<uuid>[] | null

The list IDs to filter by

semanticQuery

string | null

The semantic search query to find companies with. More natural language version of the standard query.

Maximum string length: 500

semanticWeight

number<double> | null

The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default. Larger values will prioritize semantic similarity, smaller values will prioritize traditional search factors.

Required range: 0 <= x <= 1

exclude

object | null

Exclusion filters to apply on the companies. If a company matches any of the filters here, it will be excluded from the results.

Show child attributes

query

string | null

The search query to apply on the company name and domain

Maximum string length: 250

foundedYear

object | null

The range of years

Show child attributes

fundingAmount

object | null

The funding amount range to filter by

Show child attributes

fundingYear

object | null

The range of years

Show child attributes

categoryOperator

any | null

The operator to apply to the filters. Defaults to And.

Available options:

And,

Or,

null

keywordsOperator

any | null

The operator to apply to the filters. Defaults to And.

Available options:

And,

Or,

null

technologiesOperator

any | null

The operator to apply to the filters. Defaults to And.

Available options:

And,

Or,

null

workforceGrowth

object | null

Filter companies by workforce growth percentage over a selected period and department.

Show child attributes

workforceSize

object[] | null

Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.

Show child attributes

require

enum<string>[] | null

The features that must exist for the company

Available options:

linkedin,

twitter,

facebook,

instagram,

angellist,

crunchbase,

youtube,

country,

city,

state,

revenue,

foundedYear,

anyFunding

regions

string[] | null

The region IDs to filter by

countries

string[] | null

The 2 letter country codes to filter by

states

integer<int32>[] | null

The state IDs to filter by

cities

integer<int32>[] | null

The city IDs to filter by

type

enum<string>[] | null

The list of company types to filter by

Available options:

private,

public,

self-employed,

self-owned,

partnership,

nonprofit,

educational,

government

Response

items

object[]

required

The items in the list

Show child attributes

metadata

object | null

The additional metadata for the list

Show child attributes

nextCursor

string | null

The cursor for the next page

previousCursor

string | null

The cursor for the previous page

totalItems

integer<int32>

The total number of items in the list

startIndex

integer<int32> | null

The index of the first item in the entire result set

Overview

Company · Enrichment

Company · Bulk Enrichment

Company · Search

Company · Export

Company · Similar

Industries

Keywords

Technologies

Positions

User

Jobs

Company · Lists

People · Search

People · Enrichment

People · Export

Geo

Scroll

Authorizations

Query Parameters

Body

Response