POST/v2/live/discover/people

Discover people

Returns persons matching criteria

Version
v2 · Deprecated
Rate limit
Tier 2 · 10–100 rps by plan
Billing
Discover · Discover people

Request body

  • aggkCompanyIdstring[]Optional
    AggKnowledge Company IDs to restrict search to specific companies
  • aggkProductIdinteger (int64)[]Optional
    AggKnowledge Product IDs
    48211
    Enter adds a value · Backspace on empty removes the last
  • categoryIdinteger (int64)[]Optional
    Category IDs
  • companyTypestring[]Optional
    Company type
  • countrystringOptional
    Company country
  • cursorstringOptional
    Pagination cursor from previous response for fetching next page of results
  • earliestCurrentStartDateAtCompanystringOptional
    Earliest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)
  • earliestEndDatestringOptional
    Earliest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)
  • earliestOriginalStartDateAtCompanystringOptional
    Earliest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)
  • earliestStartDatestringOptional
    Earliest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)
  • employeeCountRangestring[]Optional
    Employee count ranges
  • fundingRoundCountobjectOptional
    Funding round count range
  • fundingTotalobjectOptional
    Total funding range
  • industrystring[]Optional
    Industry categories
  • jobTitlestring[]Optional
    Job titles. Bounded by the total number of words rather than by the number of values, so one long title costs as much as several short ones; a filter too large to evaluate is rejected with a 400
  • latestCurrentStartDateAtCompanystringOptional
    Latest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)
  • latestEndDatestringOptional
    Latest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)
  • latestFundingAmountobjectOptional
    Latest funding amount range
  • latestFundingDateobjectOptional
    Latest funding date range
  • latestFundingStagestring[]Optional
    Latest funding stage
  • latestOriginalStartDateAtCompanystringOptional
    Latest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)
  • latestStartDatestringOptional
    Latest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)
  • limitinteger (int32)Optional
    Maximum number of results to return per page (default: 1000, max: 1000)
  • localitystringOptional
    Company locality
  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
  • personCountrystringOptional
    Person country
  • personFilterenum PersonFilterOptional
    Person employment filter
  • personLocalitystringOptional
    Person locality (city)
  • personRegionstringOptional
    Person region (state)
  • primaryExchangestring[]Optional
    Primary exchanges
  • primaryTickerstring[]Optional
    Primary ticker symbols
  • regionstringOptional
    Company region
  • revenueRangeInferredstring[]Optional
    Revenue range inferred
  • rolestring[]Optional
    Roles
  • senioritystring[]Optional
    Seniority levels
  • subrolestring[]Optional
    Sub-roles
  • groupingobjectOptional
    Result diversity controls
Headers
x-api-key Required · API key for authentication

Response

  • dataobject[]
    List of persons matching the search criteria
    • aggkCompanyIdinteger (int64)
      AggKnowledge Company ID
    • aggkProductIdinteger (int64)
      AggKnowledge Product ID
    • companystring
      Company name
    • currentCompaniesobject[]
      List of current companies where the person works
    • currentStartDateAtCompanystring
      Start date of the person's current stint at the matched company
    • endDatestring
      End date of the matched work experience
    • firstNamestring
      Person first name
    • idinteger (int64)
      AggKnowledge Person ID
    • jobTitlestring
      Job title
    • lastNamestring
      Person last name
    • linkedinUrlstring
      Normalized Linkedin URL
    • matchingCompanyobject
      Company attributes for the matched work experience
    • matchingProductobject
      Product attributes for the matched work experience
    • originalStartDateAtCompanystring
      Start date of the person's earliest stint at the matched company
    • personCountrystring
      Person's country
    • personLocalitystring
      Person's locality (city)
    • personRegionstring
      Person's region (state)
    • productNamestring
      Product name relevant to the search
    • rolestring
      Person role
    • senioritystring
      Person seniority
    • startDatestring
      Start date of the matched work experience
    • subrolestring
      Person subrole
    • totalStintsAtCompanyinteger (int32)
      Total number of stints the person has had at the matched company
  • hasProblemsboolean
    Whether we hit a problem answering the request: the profile or company wasn't found, or a data source failed or timed out. Data may be missing or incomplete; problems, where the response has it, says which.
  • isRetryableboolean
    When isSuccess is false, whether sending the same input again could succeed. Always true when isSuccess is true.
  • isSuccessboolean
    true when the request was answered with a result. false means no result was returned: check isRetryable, which is true when a data source failed or timed out and false when the input matched nothing.
  • metadataobject
    Caller-supplied metadata echoed back from the request.
  • nextCursorstring
    Pagination cursor for fetching the next page of results
  • warningsstring[]
    Non-fatal warnings about the search, such as filter degradation due to scale

Status codes