v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB

Search people (deprecated)

Search people using filters and/or people Ids

post/v2/search/people

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

sizeinteger

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

frominteger

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

searchAfterstring nullable

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

onePersonPerDomainboolean

Only return one person per company

peoplePerCompanyinteger nullable

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

Example request

{
  "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"
      }
    ],
    "excludeStates": [
      {
        "abbreviation": "NY",
        "country": "us"
      },
      {
        "abbreviation": "ON",
        "country": "ca"
      },
      {
        "abbreviation": "5",
        "country": "at"
      },
      {
        "abbreviation": "SH",
        "country": "de"
      }
    ],
    "excludeCountries": [
      "us",
      "dk"
    ],
    "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,
    "revenues": [
      "0-1M",
      "1-10M",
      ">1000M"
    ],
    "departmentSizes": [
      {
        "department": "Accounting and Finance",
        "from": 5,
        "to": 10
      }
    ],
    "industries": {
      "industries": [
        "Digital Agencies",
        "Advertising Services"
      ]
    },
    "excludeIndustries": [
      "CRM",
      "B2B"
    ],
    "excludeIndustryCategories": [
      "Information Technology",
      "Privacy and Security"
    ],
    "linkedinIndustries": [
      "Management Consulting",
      "Computer Software"
    ],
    "excludeLinkedinIndustries": [
      "Management Consulting",
      "Computer Software"
    ],
    "fundingRound": {
      "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"
      }
    ],
    "fieldsExist": [
      "industries",
      "emails",
      "locations"
    ],
    "fieldsNotExist": [
      "industryCategories",
      "phones"
    ],
    "minScore": 0.95
  },
  "revealEmails": {
    "includeEmails": true,
    "webhookUrl": "https://url.com/webhook"
  },
  "revealPhones": {
    "includePhones": true,
    "webhookUrl": "https://url.com/webhook"
  },
  "peoplePerCompany": 3
}

Response

Successful Response

searchAfterstring nullable

Used for pagination. Use searchAfter returned by this request in the next request to get the next page of search results. If searchAfter is not present in the response then there is no next page.

detailstring required

Status text

totalinteger nullable

Total number of results of the search, accessible with pagination.

redirectMapobject nullable

Mapping of original domains passed in filters to their redirected domains.

creditsUsednumber required

Number of credits charged for this request.

Example response

{
  "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"
        ]
      },
      "email": {
        "address": "name@gmail.com"
      },
      "inferredEmails": [
        "john.doe@domain.com",
        "j.doe@domain.com"
      ],
      "updatedAt": "2022-10-27T12:09:37Z",
      "connectionsCount": 10,
      "followersCount": 50,
      "headline": "Senior Software Engineer | Tech Lead"
    }
  ],
  "searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
  "detail": "OK",
  "total": 32871,
  "redirectMap": {
    "given_local_domain.uk": "original.com",
    "ikea.nl": "ikea.com"
  },
  "creditsUsed": 1
}