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.

application/json

Body Required

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
      • region 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
  • Not found

  • 402 application/json

    Payment Required

    Hide response attribute Show response attribute object
    • detail string Required

      Value is Insufficient standard credits.

  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
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"],"regions":["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"
    ],
    "regions": [
      "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",
      "region": "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"
    }
  ],
  "searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
  "detail": "OK",
  "total": 32871
}
Response examples (402)
{
  "detail": "Insufficient standard credits"
}
Response examples (422)
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}