Discover Sidekick (natural language search)

Headers

x-api-key Required · API key for authentication

Response

• dataobject[]

  12 properties −
  List of persons matching the search criteria
  • currentPositionsobject[]

    7 properties +
    List of current positions where the person works
  • firstNamestring
    Person first name
  • idinteger (int64)
    AggKnowledge Person ID
  • lastNamestring
    Person last name
  • linkedinUrlstring
    Normalized Linkedin URL
  • matchingCompanyobject

    11 properties +
    Company attributes for the matched work experience
  • matchingProductobject

    4 properties +
    Product attributes for the matched work experience
  • personCountrystring
    Person's country
  • personLocalitystring
    Person's locality (city)
  • personRegionstring
    Person's region (state)
  • personCountryCodestring
    The person's country, as an ISO 3166-1 alpha-2 code
  • personRegionCodestring
    The person's region (state) code
• 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
• estimatedCountinteger (int64)
  Estimated total number of matching results, counted accurately up to a cap of 5000 (larger result sets report 5000)

Status codes

• 200Sidekick search results
• 400Invalid input
• 401Unauthorized
• 402Payment required
• 429Too many requests