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
POST
/v2/search/people

Query Parameters

apiToken?string | null

Header Parameters

x-api-token?string | null

Request Body

size?integer

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

Default50
Example10
Range1 <= value <= 10000
from?integer

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

Default1
Example10
Range1 <= value <= 10001
searchAfter?string

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

Example"NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA"
peopleFilters?PeopleFilters

Collection of filters to be applied to the search

companiesFilters?CompaniesFiltersV1

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

revealEmails?RevealEmails
Example{"includeEmails":true,"webhookUrl":"https://url.com/webhook"}
revealPhones?RevealPhones
Example{"includePhones":true,"webhookUrl":"https://url.com/webhook"}
onePersonPerDomain?boolean

Only return one person per company

Defaultfalse
Examplefalse
peoplePerCompany?integer

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

Example3
Examplenull
Range1 <= value <= 5

Response Body

curl -X POST "https://api.ocean.io/v2/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"
      }
    }
  ],
  "searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
  "detail": "OK",
  "total": 32871,
  "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"
    }
  ]
}