Preview - Lookalike companies

Preview search companies using filters. Only available for enterprise API customers.

post/v3/search/companies/preview

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

sizeinteger

Number of companies to return. The maximum value is 50 and the minimum is 5

Example request

{
  "size": 50,
  "companiesFilters": {
    "lookalikeDomains": [
      "bestcustomer.com",
      "idealcustomer.com"
    ],
    "includeDomains": [
      "interesting.com",
      "amazing.com"
    ],
    "excludeDomains": [
      "boring.com",
      "useless.com"
    ],
    "companySizes": [
      "2-10",
      "51-200",
      "100001-500000"
    ],
    "ecommerce": true,
    "revenues": [
      "0-1M",
      "1-10M",
      ">1000M"
    ],
    "departmentSizes": [
      {
        "department": "Accounting and Finance",
        "from": 5,
        "to": 10
      }
    ],
    "industries": {
      "industries": [
        "Digital Agencies",
        "Advertising Services"
      ]
    },
    "excludeIndustries": [
      "CRM",
      "B2B"
    ],
    "excludeIndustryCategories": [
      "Information Technology",
      "Privacy and Security"
    ],
    "linkedinIndustries": [
      "Management Consulting",
      "Computer Software"
    ],
    "excludeLinkedinIndustries": [
      "Management Consulting",
      "Computer Software"
    ],
    "fundingRound": {
      "types": [
        "Seed",
        "Series A"
      ]
    },
    "primaryLocations": {
      "includeCountries": [
        "es"
      ],
      "excludeCountries": [
        "br",
        "de"
      ],
      "includeRegions": [
        {
          "abbreviation": "CA",
          "country": "us"
        },
        {
          "abbreviation": "YT",
          "country": "ca"
        }
      ],
      "excludeRegions": [
        {
          "abbreviation": "CA",
          "country": "us"
        },
        {
          "abbreviation": "YT",
          "country": "ca"
        }
      ],
      "includeCities": [
        {
          "city": "New York",
          "country": "us"
        },
        {
          "city": "Los Angeles",
          "country": "us"
        }
      ],
      "excludeCities": [
        {
          "city": "New York",
          "country": "us"
        },
        {
          "city": "Los Angeles",
          "country": "us"
        }
      ]
    },
    "otherLocations": {
      "includeCountries": [
        "es"
      ],
      "excludeCountries": [
        "br",
        "de"
      ],
      "includeRegions": [
        {
          "abbreviation": "CA",
          "country": "us"
        },
        {
          "abbreviation": "YT",
          "country": "ca"
        }
      ],
      "excludeRegions": [
        {
          "abbreviation": "CA",
          "country": "us"
        },
        {
          "abbreviation": "YT",
          "country": "ca"
        }
      ],
      "includeCities": [
        {
          "city": "New York",
          "country": "us"
        },
        {
          "city": "Los Angeles",
          "country": "us"
        }
      ],
      "excludeCities": [
        {
          "city": "New York",
          "country": "us"
        },
        {
          "city": "Los Angeles",
          "country": "us"
        }
      ]
    },
    "minRelevance": "B",
    "maxRelevance": "B",
    "headcountGrowth": {
      "asPercentage": true
    },
    "departmentHeadcountGrowth": {
      "anyOf": [
        {
          "asPercentage": false,
          "department": "Accounting and Finance",
          "growthRange": {
            "from": -1,
            "to": 3
          },
          "months": "Three months"
        }
      ],
      "allOf": [
        {
          "asPercentage": false,
          "department": "Accounting and Finance",
          "growthRange": {
            "from": -1,
            "to": 3
          },
          "months": "Three months"
        }
      ]
    },
    "updatedWithinMonths": 1,
    "fieldsExist": [
      "industries",
      "emails",
      "locations"
    ],
    "fieldsNotExist": [
      "industryCategories",
      "phones"
    ],
    "companyMatchingMode": "precise"
  },
  "peopleFilters": {
    "lookalikeLinkedinHandles": [
      "michael-scott-13532",
      "dwight-schrute"
    ],
    "countries": [
      "us",
      "dk"
    ],
    "includePeopleIds": [
      "43g19df9c1d70f9a",
      "54hb1b1bfb1ffc5t"
    ],
    "includeLinkedinHandles": [
      "jim-halpert-5343",
      "toby-67832"
    ],
    "excludePeopleIds": [
      "43g19df9c1d70f9a",
      "54hb1b1bfb1ffc5t"
    ],
    "excludeLinkedinHandles": [
      "jim-halpert-5343",
      "toby-67832"
    ],
    "seniorities": [
      "Founder",
      "Owner"
    ],
    "skills": {
      "allOf": [
        "Product Management",
        "Entrepreneurship"
      ],
      "anyOf": [
        "Social Media",
        "Competitive Analysis"
      ],
      "noneOf": [
        "Writing",
        "Project Management"
      ]
    },
    "jobTitleKeywords": {
      "allOf": [
        "Manager"
      ],
      "anyOf": [
        "Marketing",
        "designer"
      ],
      "noneOf": [
        "content"
      ]
    },
    "allJobDescriptions": {
      "allOf": [
        "software engineer"
      ],
      "anyOf": [
        "software engineer"
      ],
      "noneOf": [
        "entry-level"
      ]
    },
    "currentJobDescription": {
      "allOf": [
        "software engineer",
        "big tech company"
      ],
      "anyOf": [
        "software engineer"
      ],
      "noneOf": [
        "entry-level"
      ]
    },
    "profileDescription": {
      "allOf": [
        "software engineer"
      ],
      "anyOf": [
        "software engineer"
      ],
      "noneOf": [
        "entry-level"
      ]
    },
    "regions": [
      "CA",
      "TX"
    ],
    "states": [
      {
        "abbreviation": "NY",
        "country": "us"
      },
      {
        "abbreviation": "ENG",
        "country": "gb"
      },
      {
        "abbreviation": "5",
        "country": "at"
      },
      {
        "abbreviation": "SH",
        "country": "de"
      }
    ],
    "excludeStates": [
      {
        "abbreviation": "NY",
        "country": "us"
      },
      {
        "abbreviation": "ENG",
        "country": "gb"
      },
      {
        "abbreviation": "5",
        "country": "at"
      },
      {
        "abbreviation": "SH",
        "country": "de"
      }
    ],
    "excludeCountries": [
      "us",
      "dk"
    ],
    "cities": [
      {
        "city": "New York",
        "country": "us"
      },
      {
        "city": "Los Angeles",
        "country": "us"
      }
    ],
    "excludeCities": [
      {
        "city": "New York",
        "country": "us"
      },
      {
        "city": "Los Angeles",
        "country": "us"
      }
    ],
    "names": [
      "John Doe",
      "Peter Pan"
    ],
    "departments": {
      "departments": [
        "Management",
        "Marketing and Advertising"
      ]
    },
    "excludeDepartments": [
      "Management",
      "Marketing and Advertising"
    ],
    "subDepartments": {
      "subDepartments": [
        "Software development"
      ]
    },
    "excludeSubDepartments": [
      "Technical support & helpdesk"
    ],
    "fieldsExist": [
      "name",
      "country",
      "linkedinUrl"
    ],
    "fieldsNotExist": [
      "firstName",
      "location",
      "jobTitleEnglish"
    ],
    "changedPositionAfter": "2023-01",
    "changedPositionBefore": "2023-01",
    "updatedWithinMonths": 1
  }
}

Response

Successful Response

totalHitsinteger required

Total number of companies found

redirectMapobject nullable

Mapping of original domains passed in filters to their redirected domains.

creditsUsednumber required

Number of credits charged for this request.

Example response

{
  "totalHits": 5173,
  "redirectMap": {
    "given_local_domain.uk": "original.com",
    "ikea.nl": "ikea.com"
  },
  "creditsUsed": 1,
  "companies": [
    {
      "ranking": 1,
      "relevance": "A",
      "company": {
        "name": "Google",
        "logo": "https://cdn2.ocean.io/logos/ocean.io/b162ddc061a4ca67e8aacbbf747dc8e62cce7496.png",
        "topIndustries": [
          "Analytics",
          "B2B",
          "Software"
        ],
        "size": "501-1000",
        "description": "B2B Sales and Marketing teams use Ocean.io's prospecting data platform to find accounts and contacts no one else can.",
        "primaryCountry": "us",
        "primaryRegion": "CA",
        "linkedinHandle": "zoominfo"
      }
    }
  ]
}

Changes

Changed in 4 of the 6 revisions of this API.215

Sep 3, 20265a550a01847323See the full diff
- ▲
  added the new required request property //
  new-required-request-property
- ▲
  the / request property type changed from array to object
  request-property-type-changed
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
Aug 25, 2026505121e487221See the full diff
- ○
  added the new optional request property //
  new-optional-request-property
Aug 24, 20267be4c13a1cf69See the full diff
- ○
  added the new Education enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new Education enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new Education enum value to the request property ///
  request-property-enum-value-added
- ○
  added the new Education enum value to the request property //
  request-property-enum-value-added
- ○
  added the new Education enum value to the request property //
  request-property-enum-value-added
- ○
  added the new Entry enum value to the request property //
  request-property-enum-value-added
- ○
  added the new Intern enum value to the request property //
  request-property-enum-value-added
- ○
  added the new Professional enum value to the request property //
  request-property-enum-value-added
- ○
  added the new Senior enum value to the request property //
  request-property-enum-value-added
Jul 26, 20260f900a1e318f2See the full diff
- ○
  the /// request property's max was increased from 500000.00 to 1000000.00
  request-property-max-increased
- ○
  the /// request property's max was increased from 500000.00 to 1000000.00
  request-property-max-increased

Full history