Search
Lookalike people search
Search people using filters and/or people Ids
Looking for the legacy endpoint? Access it here
Cost calculation:
- Request that contains one or more lookalike people or one or more lookalike companies - 3 credits per person in result
- Request that does not contain lookalike people and does not include lookalike companies - 1 credit per person in result
Webhook result: Email results Phone results
Query Parameters
apiToken?string | null
Header Parameters
x-api-token?string | null
size?integer
Number of people to return. The maximum value is 10,000.
Default
50Example
10Range
1 <= value <= 10000peopleFilters?PeopleFiltersV3
Collection of filters to be applied to the search
companiesFilters?CompaniesFiltersV3
Collection of companies filters, the search results will display people that are associated with those companies
peoplePerCompany?integer
Number of people to return per company. If you want to return all people from a company, don't set this value.
Example
3Example
nullRange
1 <= valuejobTitleThreshold?number
Threshold for job title similarity. The value must be between 0 and 1. Default is 0.8
Default
0.8Example
0.8Range
0 <= value <= 1searchAfter?string
Use searchAfter returned by the previous request to get the next page.
Example
"N4IglgdgJgpgHiAXAVgL5A"Response Body
curl -X POST "https://api.ocean.io/v3/search/people?apiToken=string" \
-H "x-api-token: string" \
-H "Content-Type: application/json" \
-d '{}'{
"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"
},
"company": {
"companySize": "2-10",
"logo": "https://cdn2.ocean.io/companies-logos-v1/domain.com/020539e284d9318e805301b672ad23047c30818a.png",
"name": "Dunder Mifflin Paper Company"
}
}
],
"detail": "OK",
"lookalikePeopleStatuses": {
"successfulPeople": [
"person_id_1",
"person_id_2"
],
"notFoundPeople": [
"person_id_1",
"person_id_2"
],
"triggeredDomainPeople": [
"person_id_1",
"person_id_2"
],
"missingCompanyInformationPeople": [
"person_id_1",
"person_id_2"
]
},
"total": 32871,
"searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
"redirectMap": {
"given_local_domain.uk": "original.com",
"ikea.nl": "ikea.com"
}
}{
"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"
}Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}