Search people (deprecated)
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/json
Requiredsize
Maximum number of resultsNumber of people to return. The maximum value is 10,000. To get more than 10,000 results, use searchAfter
.
50
Minimum: 1
Maximum: 10000
from
Index 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
1
Minimum: 1
Maximum: 10001
searchAfter
string | null | nullpeopleFilters
object | null | nullcompaniesFilters
object | null | nullrevealEmails
object | null | nullrevealPhones
object | null | nullonePersonPerDomain
OnepersonperdomainOnly return one person per company
false
peoplePerCompany
integer | null | nullQuery Parameters
apiToken
string | null | nullHeader Parameters
x-api-token
string | null | nullResponse Body
Successful Response
TypeScript Definitions
Use the response body type in TypeScript.
people
RequiredPeoplesearchAfter
string | null | nulldetail
RequiredDetailStatus text
total
integer | null | nullBad Request
TypeScript Definitions
Use the response body type in TypeScript.
detail
Requiredstring"Conflicting API tokens provided in query parameters and headers"
Payment Required
TypeScript Definitions
Use the response body type in TypeScript.
detail
Requiredstring"Insufficient standard credits"
Forbidden
TypeScript Definitions
Use the response body type in TypeScript.
detail
Requiredstring"API token should be provided in headers or query parameters" | "Current API token is not registered in our database"
Not found
Validation Error
TypeScript Definitions
Use the response body type in TypeScript.
detail
Detailcurl -X POST "https://api.ocean.io/v2/search/people?apiToken=string" \
-H "x-api-token: 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",
"changedPositionBefore": "2023-01"
},
"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,
"yearFounded": {
"from": 1960,
"to": 1990
},
"countriesCount": {
"from": 1,
"to": 5
},
"revenues": [
"0-1M",
"1-10M",
">1000M"
],
"employeeCountOcean": {
"from": 10,
"to": 100
},
"mobileApps": {
"from": 1,
"to": 5
},
"locationsCount": {
"from": 5,
"to": 10
},
"departmentSizes": [
{
"department": "Accounting and Finance",
"from": 5,
"to": 10
}
],
"employeeCountLinkedin": {
"from": 50,
"to": 100
},
"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"
],
"fundingRound": {
"date": {
"from": "2020-01-01",
"to": "2023-01-01"
},
"raised": {
"from": 1000000,
"to": 5000000
},
"types": [
"Seed",
"Series A"
]
},
"countries": [
"es",
"pt"
],
"primaryCountries": [
"de"
],
"states": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"primaryStates": [
{
"abbreviation": "NY",
"country": "us"
}
],
"cities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"primaryCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"headquarterGeolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
},
"geolocation": {
"latitude": 50.83348,
"longitude": -0.1410065,
"radius": 5000
},
"webTrafficVisits": {
"from": 1000,
"to": 10000
},
"keywords": {
"keywords": [
"premium copy paper",
"paper"
],
"mode": "anyOf"
},
"fieldsExist": [
"industries",
"emails",
"locations"
],
"fieldsNotExist": [
"industryCategories",
"phones"
],
"socialMedias": {
"medias": [
"linkedin",
"facebook"
],
"mode": "anyOf"
},
"technologies": {
"mode": "anyOf",
"technologies": [
"Amazon Advertising",
"Google Maps"
]
},
"minScore": 0.95
},
"revealEmails": {
"includeEmails": true,
"webhookUrl": "https://url.com/webhook"
},
"revealPhones": {
"includePhones": true,
"webhookUrl": "https://url.com/webhook"
},
"onePersonPerDomain": false,
"peoplePerCompany": 3
}'
const body = JSON.stringify({
"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",
"changedPositionBefore": "2023-01"
},
"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,
"yearFounded": {
"from": 1960,
"to": 1990
},
"countriesCount": {
"from": 1,
"to": 5
},
"revenues": [
"0-1M",
"1-10M",
">1000M"
],
"employeeCountOcean": {
"from": 10,
"to": 100
},
"mobileApps": {
"from": 1,
"to": 5
},
"locationsCount": {
"from": 5,
"to": 10
},
"departmentSizes": [
{
"department": "Accounting and Finance",
"from": 5,
"to": 10
}
],
"employeeCountLinkedin": {
"from": 50,
"to": 100
},
"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"
],
"fundingRound": {
"date": {
"from": "2020-01-01",
"to": "2023-01-01"
},
"raised": {
"from": 1000000,
"to": 5000000
},
"types": [
"Seed",
"Series A"
]
},
"countries": [
"es",
"pt"
],
"primaryCountries": [
"de"
],
"states": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"primaryStates": [
{
"abbreviation": "NY",
"country": "us"
}
],
"cities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"primaryCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"headquarterGeolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
},
"geolocation": {
"latitude": 50.83348,
"longitude": -0.1410065,
"radius": 5000
},
"webTrafficVisits": {
"from": 1000,
"to": 10000
},
"keywords": {
"keywords": [
"premium copy paper",
"paper"
],
"mode": "anyOf"
},
"fieldsExist": [
"industries",
"emails",
"locations"
],
"fieldsNotExist": [
"industryCategories",
"phones"
],
"socialMedias": {
"medias": [
"linkedin",
"facebook"
],
"mode": "anyOf"
},
"technologies": {
"mode": "anyOf",
"technologies": [
"Amazon Advertising",
"Google Maps"
]
},
"minScore": 0.95
},
"revealEmails": {
"includeEmails": true,
"webhookUrl": "https://url.com/webhook"
},
"revealPhones": {
"includePhones": true,
"webhookUrl": "https://url.com/webhook"
},
"onePersonPerDomain": false,
"peoplePerCompany": 3
})
fetch("https://api.ocean.io/v2/search/people?apiToken=string", {
headers: {
"x-api-token": "string"
},
body
})
package main
import (
"fmt"
"net/http"
"io/ioutil"
"strings"
)
func main() {
url := "https://api.ocean.io/v2/search/people?apiToken=string"
body := strings.NewReader(`{
"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",
"changedPositionBefore": "2023-01"
},
"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,
"yearFounded": {
"from": 1960,
"to": 1990
},
"countriesCount": {
"from": 1,
"to": 5
},
"revenues": [
"0-1M",
"1-10M",
">1000M"
],
"employeeCountOcean": {
"from": 10,
"to": 100
},
"mobileApps": {
"from": 1,
"to": 5
},
"locationsCount": {
"from": 5,
"to": 10
},
"departmentSizes": [
{
"department": "Accounting and Finance",
"from": 5,
"to": 10
}
],
"employeeCountLinkedin": {
"from": 50,
"to": 100
},
"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"
],
"fundingRound": {
"date": {
"from": "2020-01-01",
"to": "2023-01-01"
},
"raised": {
"from": 1000000,
"to": 5000000
},
"types": [
"Seed",
"Series A"
]
},
"countries": [
"es",
"pt"
],
"primaryCountries": [
"de"
],
"states": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"primaryStates": [
{
"abbreviation": "NY",
"country": "us"
}
],
"cities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"primaryCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"headquarterGeolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
},
"geolocation": {
"latitude": 50.83348,
"longitude": -0.1410065,
"radius": 5000
},
"webTrafficVisits": {
"from": 1000,
"to": 10000
},
"keywords": {
"keywords": [
"premium copy paper",
"paper"
],
"mode": "anyOf"
},
"fieldsExist": [
"industries",
"emails",
"locations"
],
"fieldsNotExist": [
"industryCategories",
"phones"
],
"socialMedias": {
"medias": [
"linkedin",
"facebook"
],
"mode": "anyOf"
},
"technologies": {
"mode": "anyOf",
"technologies": [
"Amazon Advertising",
"Google Maps"
]
},
"minScore": 0.95
},
"revealEmails": {
"includeEmails": true,
"webhookUrl": "https://url.com/webhook"
},
"revealPhones": {
"includePhones": true,
"webhookUrl": "https://url.com/webhook"
},
"onePersonPerDomain": false,
"peoplePerCompany": 3
}`)
req, _ := http.NewRequest("POST", url, body)
req.Header.Add("x-api-token", "string")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
import requests
url = "https://api.ocean.io/v2/search/people?apiToken=string"
body = {
"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",
"changedPositionBefore": "2023-01"
},
"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,
"yearFounded": {
"from": 1960,
"to": 1990
},
"countriesCount": {
"from": 1,
"to": 5
},
"revenues": [
"0-1M",
"1-10M",
">1000M"
],
"employeeCountOcean": {
"from": 10,
"to": 100
},
"mobileApps": {
"from": 1,
"to": 5
},
"locationsCount": {
"from": 5,
"to": 10
},
"departmentSizes": [
{
"department": "Accounting and Finance",
"from": 5,
"to": 10
}
],
"employeeCountLinkedin": {
"from": 50,
"to": 100
},
"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"
],
"fundingRound": {
"date": {
"from": "2020-01-01",
"to": "2023-01-01"
},
"raised": {
"from": 1000000,
"to": 5000000
},
"types": [
"Seed",
"Series A"
]
},
"countries": [
"es",
"pt"
],
"primaryCountries": [
"de"
],
"states": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"primaryStates": [
{
"abbreviation": "NY",
"country": "us"
}
],
"cities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"primaryCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"headquarterGeolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
},
"geolocation": {
"latitude": 50.83348,
"longitude": -0.1410065,
"radius": 5000
},
"webTrafficVisits": {
"from": 1000,
"to": 10000
},
"keywords": {
"keywords": [
"premium copy paper",
"paper"
],
"mode": "anyOf"
},
"fieldsExist": [
"industries",
"emails",
"locations"
],
"fieldsNotExist": [
"industryCategories",
"phones"
],
"socialMedias": {
"medias": [
"linkedin",
"facebook"
],
"mode": "anyOf"
},
"technologies": {
"mode": "anyOf",
"technologies": [
"Amazon Advertising",
"Google Maps"
]
},
"minScore": 0.95
},
"revealEmails": {
"includeEmails": true,
"webhookUrl": "https://url.com/webhook"
},
"revealPhones": {
"includePhones": true,
"webhookUrl": "https://url.com/webhook"
},
"onePersonPerDomain": false,
"peoplePerCompany": 3
}
response = requests.request("POST", url, json = body, headers = {
"x-api-token": "string",
"Content-Type": "application/json"
})
print(response.text)
{
"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",
"currentJobDescription": "Software Engineer specializing in cloud infrastructure",
"experiences": [
{
"dateFrom": "2020-01-01",
"dateTo": "2021-01-01",
"description": "Software Engineer specializing in cloud infrastructure",
"domain": "domain.com",
"jobTitle": "Software Engineer"
}
],
"summary": "Some text that the person wrote to describe themselves",
"skills": [
"Product Management",
"Entrepreneurship",
"Social Media"
],
"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
}
{
"detail": "Conflicting API tokens provided in query parameters and headers"
}
{
"detail": "Insufficient standard credits"
}
{
"detail": "API token should be provided in headers or query parameters"
}
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}