POST/v3/live/healthcare/hcp/{aggkHcpId}/publications

Get HCP publications

Returns publications for a healthcare professional, paginated with limit (default 100, max 1000) and an opaque cursor.

Version
v3
Rate limit
Tier 3 · 10–200 rps by plan
Billing
Healthcare (HCP) · Get HCP publications

Path parameters

  • aggkHcpIdstringRequired
    AggK HCP ID

Request body

  • limitinteger (int32)Optional
    Maximum number of results to return (default 100, max 1000)
  • cursorstringOptional
    Opaque cursor returned by a previous page; omit to fetch the first page
  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
Headers
x-api-key Required · API key for authentication

Response

  • resultsobject[]
    Publications for this HCP
    • abstractTextstring
      Publication abstract
    • citationCountinteger (int32)
      Number of citations
    • datePublishedstring
      Date the publication was published
    • doistring
      Digital Object Identifier (DOI)
    • isFirstAuthorboolean
      Whether the HCP is the first author
    • isLastAuthorboolean
      Whether the HCP is the last author
    • journalstring
      Journal name
    • keywordsobject[]
      Keywords associated with the publication, each with its UMLS CUI where one could be resolved. Mostly PubMed MeSH headings, so they cover study designs and populations as well as diseases
    • pubIdstring
      Publication ID (PubMed ID or equivalent)
    • publicationTypesstring[]
      Publication types (e.g. 'Letter', 'Review')
    • socialMediaCountinteger (int32)
      Number of social media mentions
    • titlestring
      Publication title
    • urlstring
      URL to the publication
  • nextCursorstring
    Cursor for the next page; absent when there are no more results
  • 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.
  • isRetryableboolean
    When isSuccess is false, whether sending the same input again could succeed. Always true when isSuccess is true.
  • 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.
  • metadataobject
    Caller-supplied metadata echoed back from the request.
  • inputParametersobject
    Caller-supplied inputs echoed back in the response

Status codes