Search people

Search people using filters and/or people Ids **Cost calculation:** - Request that contains one or more lookalike company domains - 3 credits per person in result - Request that does not contain any lookalike company domains - 1 credit per person in result

Request Body

application/jsonRequired

sizeMaximum number of results

Number of people to return. The maximum value is 10,000. To get more than 10,000 results, use searchAfter.

Default: 50Minimum: 1Maximum: 10000

fromIndex the returned results start from.

Return people from number X. Passing 1 will return all the results. Passing 10 will return results from the 10th. Note: size + from cannot be higher than 10,001

Default: 1Minimum: 1Maximum: 10001

searchAfterSearch after

Use searchAfter returned by the previous request to get the next page. Note: this cannot be used together with onePersonPerDomain enabled.

peopleFiltersPeople filters

Collection of filters to be applied to the search

companiesFiltersCompanies filters

Collection of companies filters, the search results will display people that are associated with those companies

revealEmailsReveal emails

revealPhonesReveal phones

onePersonPerDomainOnepersonperdomain

Only return one person per company

Default: false

peoplePerCompanyPeople per company

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

Query Parameters

apiTokenRequiredApitoken

curl -X POST "https://api.ocean.io/v2/search/people?apiToken=string" \
  -H "Content-Type: application/json" \
  -d '{
    "size": 10,
    "from": 10,
    "searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
    "peopleFilters": {
      "includeIds": [
        "51e19df9c1d70c7c",
        "971b1b1bfb1ffb1a"
      ],
      "excludeIds": [
        "51e19df9c1d70c7c",
        "971b1b1bfb1ffb1a"
      ],
      "seniorities": [
        "Founder",
        "Owner"
      ],
      "jobTitles": [
        "CEO",
        "CTO"
      ],
      "excludeJobTitles": [
        "CEO",
        "CTO"
      ],
      "departments": [
        "Management",
        "Marketing and Advertising"
      ],
      "countries": [
        "us",
        "dk"
      ],
      "states": [
        {
          "abbreviation": "NY",
          "country": "us"
        },
        {
          "abbreviation": "ON",
          "country": "ca"
        },
        {
          "abbreviation": "5",
          "country": "at"
        },
        {
          "abbreviation": "SH",
          "country": "de"
        }
      ],
      "names": [
        "John Doe",
        "Peter Pan"
      ],
      "emails": [
        "email_1@domain.com",
        "email_2@domain.com"
      ],
      "keywords": [
        "engineering",
        "research"
      ],
      "fieldsExist": [
        "name",
        "country",
        "linkedinUrl"
      ],
      "fieldsNotExist": [
        "firstName",
        "location",
        "jobTitleEnglish"
      ],
      "changedPositionAfter": "2023-01"
    },
    "companiesFilters": {
      "lookalikeDomains": [
        "bestcustomer.com",
        "idealcustomer.com"
      ],
      "minScore": 0.95,
      "includeDomains": [
        "interesting.com",
        "amazing.com"
      ],
      "excludeDomains": [
        "boring.com",
        "useless.com"
      ],
      "companySizes": [
        "2-10",
        "51-200",
        "100001-500000"
      ],
      "ecommerce": true,
      "socialMedias": {
        "medias": [
          "linkedin",
          "facebook"
        ],
        "mode": "anyOf"
      },
      "yearFounded": {
        "from": 1960,
        "to": 1990
      },
      "countriesCount": {
        "from": 1,
        "to": 5
      },
      "revenues": [
        "0-1M",
        "1-10M",
        ">1000M"
      ],
      "employeeCountOcean": {
        "from": 10,
        "to": 100
      },
      "webTrafficVisits": {
        "from": 1000,
        "to": 10000
      },
      "mobileApps": {
        "from": 1,
        "to": 5
      },
      "headquarterGeolocation": {
        "latitude": 38.880817,
        "longitude": -77.10216,
        "radius": 1000
      },
      "geolocation": {
        "latitude": 50.83348,
        "longitude": -0.1410065,
        "radius": 5000
      },
      "locationsCount": {
        "from": 5,
        "to": 10
      },
      "departmentSizes": [
        {
          "department": "Accounting and Finance",
          "from": 5,
          "to": 10
        }
      ],
      "keywords": {
        "keywords": [
          "premium copy paper",
          "paper"
        ],
        "mode": "anyOf"
      },
      "states": [
        {
          "abbreviation": "CA",
          "country": "us"
        },
        {
          "abbreviation": "YT",
          "country": "ca"
        }
      ],
      "primaryStates": [
        {
          "abbreviation": "NY",
          "country": "us"
        }
      ],
      "employeeCountLinkedin": {
        "from": 50,
        "to": 100
      },
      "countries": [
        "es",
        "pt"
      ],
      "primaryCountries": [
        "de"
      ],
      "industries": {
        "industries": [
          "Advertising Platforms",
          "Biopharma"
        ],
        "mode": "anyOf"
      },
      "excludeIndustries": [
        "CRM",
        "B2B"
      ],
      "industryCategories": {
        "industryCategories": [
          "Real Estate",
          "Hardware"
        ],
        "mode": "anyOf"
      },
      "excludeIndustryCategories": [
        "Information Technology",
        "Privacy and Security"
      ],
      "linkedinIndustries": [
        "Management Consulting",
        "Computer Software"
      ],
      "excludeLinkedinIndustries": [
        "Management Consulting",
        "Computer Software"
      ],
      "technologies": {
        "mode": "anyOf",
        "technologies": [
          "Amazon Advertising",
          "Google Maps"
        ]
      },
      "fundingRound": {
        "date": {
          "from": "2020-01-01",
          "to": "2023-01-01"
        },
        "raised": {
          "from": 1000000,
          "to": 5000000
        },
        "types": [
          "Seed",
          "Series A"
        ]
      },
      "fieldsExist": [
        "industries",
        "emails",
        "locations"
      ],
      "fieldsNotExist": [
        "industryCategories",
        "phones"
      ]
    },
    "revealEmails": {
      "includeEmails": true,
      "webhookUrl": "https://url.com/webhook"
    },
    "revealPhones": {
      "includePhones": true,
      "webhookUrl": "https://url.com/webhook"
    },
    "onePersonPerDomain": false,
    "peoplePerCompany": 3
  }'

Successful Response

{
  "people": [
    {
      "id": "e9447c74eafa8a19",
      "domain": "google.com",
      "name": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "country": "us",
      "state": "CA",
      "location": "Copenhagen, Capital Region, Denmark",
      "linkedinUrl": "https://www.linkedin.com/in/someone",
      "seniorities": [
        "C-Level",
        "Manager"
      ],
      "departments": [
        "Management",
        "Marketing and Advertising"
      ],
      "photo": "http://media.licdn.com/dms/image/somelink",
      "jobTitle": "Professeur",
      "jobTitleEnglish": "Teacher",
      "summary": "Some text that the person wrote to describe themselves",
      "phone": {
        "numbers": [
          "+4512345678",
          "+33 6 00 00 00 00"
        ],
        "status": "verified"
      },
      "email": {
        "address": "example.jonas@ocean.io",
        "status": "verified"
      }
    }
  ],
  "searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
  "detail": "OK",
  "total": 32871
}

Search people

Request Body

Query Parameters

Response

TypeScript