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

Get HCP trials

Returns clinical trials 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 trials

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[]
    Clinical trials for this HCP
    • briefTitlestring
      Brief title of the trial
    • completionDatestring
      Overall completion date
    • eligibilityCriteriastring
      Eligibility criteria for the trial
    • lastUpdatePostedstring
      Date the last update was posted
    • lastUpdateSubmittedstring
      Date the last update was submitted
    • officialTitlestring
      Official title of the trial
    • phasestring
      Trial phase (e.g. Phase 2)
    • primaryCompletionDatestring
      Primary completion date
    • startDatestring
      Trial start date
    • statusstring
      Recruitment status (e.g. Recruiting)
    • summarystring
      Plain-language summary of the trial
    • trialIdstring
      ClinicalTrials.gov identifier (e.g. NCT04427332)
    • typestring
      Trial type (e.g. Interventional)
    • urlstring
      Clinical trial URL
  • 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