Lookalike people search (RC)

POST /v3/search/people

Note: this endpoint is marked as a Release Candidate (RC). We won't change the format of parameters/results but there is a lot we want to improve, mainly about speed, stability and number of results. Search people using filters. Note: at the moment, lookalikePeopleIds is mandatory.

Query parameters

apiToken string Required

application/json

Body Required

size integer

Number of people to return. The maximum value is 10,000.

Minimum value is 1.0, maximum value is 10000.0. Default value is 50.
peopleFilters object | null

Additional properties are NOT allowed.
Hide peopleFilters attributes Show peopleFilters attributes object | null
- lookalikePeopleIds array[string] | null
- lookalikeLinkedinHandles array[string] | null
- countries array[string] | null
- excludePeopleIds array[string] | null
- excludeLinkedinHandles array[string] | null
- seniorities array[string] | null
  
  Values are Owner, Founder, Board Member, C-Level, Partner, VP, Head, Director, Manager, or Other.
- states array[string] | null
companiesFilters object | null

Additional properties are NOT allowed.
Hide companiesFilters attributes Show companiesFilters attributes object | null
- lookalikeDomains array[string] | null
- includeDomains array[string] | null
- industries array[string] | null
- excludeDomains array[string] | null
- primaryCountries array[string] | null
- companySizes array[string] | null
  
  Values are 0-1, 2-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001-50000, 50001-100000, 100001-500000, or 500000+.
peoplePerCompany integer | null

Minimum value is 1.0.
jobTitleThreshold number | null

Minimum value is 0.0, maximum value is 1.0. Default value is 0.8.

Responses

200 application/json

Successful Response
Hide response attributes Show response attributes object
- people array[object] Required
  
  Hide people attributes Show people attributes object
  
  id string Required
  
  Internal ocean id of the person
  
  domain string Required
  
  Domain of the company the person is working for
  
  name string | null
  
  firstName string | null
  
  lastName string | null
  
  country string | null
  
  location string | null
  
  linkedinUrl string | null
  
  seniorities array[string] | null
  
  Values are Owner, Founder, Board Member, C-Level, Partner, VP, Head, Director, Manager, or Other.
  
  departments array[string] | null
  
  Values are Accounting and Finance, Board, Business Support, Customer Relations, Design, Editorial Personnel, Engineering, Founder/Owner, Healthcare, HR, Legal, Management, Manufacturing, Marketing and Advertising, Operations, PR and Communications, Procurement, Product, Quality Control, R&D, Sales, Security, Supply Chain, or Other.
  
  photo string | null
  
  jobTitle string | null
  
  jobTitleEnglish string | null
  
  summary string | null
- searchAfter string | null
- detail string Required
  
  Status text
- total integer | null
404

Not found
422 application/json

Validation Error
Hide response attribute Show response attribute object
- detail array[object]
  
  Hide detail attributes Show detail attributes object
  
  loc array[string | integer] Required
  
  msg string Required
  
  type string Required

POST /v3/search/people

curl \
 -X POST https://api.ocean.io/v3/search/people?apiToken=string \
 -H "Content-Type: application/json" \
 -d '{"size":10,"peopleFilters":{"lookalikePeopleIds":["string"],"lookalikeLinkedinHandles":["string"],"countries":["string"],"excludePeopleIds":["string"],"excludeLinkedinHandles":["string"],"seniorities":["Founder","Owner"],"states":["string"]},"companiesFilters":{"lookalikeDomains":["string"],"includeDomains":["string"],"industries":["string"],"excludeDomains":["string"],"primaryCountries":["de"],"companySizes":["2-10","51-200","100001-500000"]},"peoplePerCompany":3,"jobTitleThreshold":0.8}'

Request examples

{
  "size": 10,
  "peopleFilters": {
    "lookalikePeopleIds": [
      "string"
    ],
    "lookalikeLinkedinHandles": [
      "string"
    ],
    "countries": [
      "string"
    ],
    "excludePeopleIds": [
      "string"
    ],
    "excludeLinkedinHandles": [
      "string"
    ],
    "seniorities": [
      "Founder",
      "Owner"
    ],
    "states": [
      "string"
    ]
  },
  "companiesFilters": {
    "lookalikeDomains": [
      "string"
    ],
    "includeDomains": [
      "string"
    ],
    "industries": [
      "string"
    ],
    "excludeDomains": [
      "string"
    ],
    "primaryCountries": [
      "de"
    ],
    "companySizes": [
      "2-10",
      "51-200",
      "100001-500000"
    ]
  },
  "peoplePerCompany": 3,
  "jobTitleThreshold": 0.8
}

Response examples (200)

{
  "people": [
    {
      "id": "e9447c74eafa8a19",
      "domain": "google.com",
      "name": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "country": "us",
      "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"
    }
  ],
  "searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
  "detail": "OK",
  "total": 32871
}

Response examples (422)

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}