v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB

Preview - Lookalike people

Preview search people with company information. Only available for enterprise API customers.

post/v3/search/people/preview

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

sizeinteger

Number of people to return

peoplePerCompanyinteger nullable

Number of people to return per company. If you want to return all people from a company, don't set this value.

jobTitleThresholdnumber nullable

Threshold for job title similarity. The value must be between 0 and 1. Default is 0.8

searchAfterstring nullable

Use searchAfter returned by the previous request to get the next page.

Example request

{
  "size": 50,
  "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": [
      "Management",
      "Marketing and Advertising"
    ],
    "excludeDepartments": [
      "Management",
      "Marketing and Advertising"
    ],
    "fieldsExist": [
      "name",
      "country",
      "linkedinUrl"
    ],
    "fieldsNotExist": [
      "firstName",
      "location",
      "jobTitleEnglish"
    ],
    "changedPositionAfter": "2023-01",
    "changedPositionBefore": "2023-01",
    "updatedWithinMonths": 1
  },
  "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"
  },
  "peoplePerCompany": 3,
  "jobTitleThreshold": 0.8,
  "searchAfter": "N4IglgdgJgpgHiAXAVgL5A",
  "fields": [
    "id",
    "domain",
    "name",
    "firstName",
    "lastName",
    "country",
    "state",
    "location",
    "linkedinUrl",
    "seniorities",
    "departments",
    "photo",
    "jobTitle",
    "jobTitleEnglish",
    "currentJobDescription",
    "experiences",
    "summary",
    "skills",
    "headline",
    "updatedAt",
    "connectionsCount",
    "followersCount",
    "company.revenue",
    "company.peopleCount",
    "company.industries",
    "company.technologies",
    "company.latestFundingRound"
  ]
}

Response

Successful Response

detailstring required

Status text

totalinteger nullable

Total number of the available results.

redirectMapobject nullable

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

creditsUsednumber required

Number of credits charged for this request.

Example response

{
  "detail": "OK",
  "total": 75,
  "redirectMap": {
    "given_local_domain.uk": "original.com",
    "ikea.nl": "ikea.com"
  },
  "creditsUsed": 1,
  "people": [
    {
      "ranking": 1,
      "person": {
        "name": "John ***",
        "jobTitle": "CEO"
      },
      "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"
      }
    }
  ]
}