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

Get HCP congresses

Returns congress participations 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 congresses

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[]
    Congress participations for this HCP
    • conferenceNamestring
      Conference name
    • congressIdstring
      Congress ID
    • descriptionstring
      Description
    • endDatestring
      Conference end date
    • organizerNamestring
      Organizer name
    • presentedDatestring
      Date the HCP presented
    • sessionTypestring
      Session type
    • startDatestring
      Conference start date
    • titlestring
      Presentation title
    • typestring
      Presentation type (e.g. Poster, Oral)
  • 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