CLcloverhealth
Engagements

Get member context for an engagement (external)

Changed on

Requires OAuth scope: engagement:context

All callers with the base scope receive member_verified, intent, category, and mx_agent alongside the other basic identifying fields. A JWT additionally granted engagement:context:full also receives master_record_id, support_team, and the Engagement's full metadata blob -- same as the internal endpoint. Callers without that scope never see those keys.

Note: engagement_id is an opaque UUID, safe as a path parameter. Member PHI (name, subscriber ID, language) is returned in the body only.

get/api/v1/external/engagements/{engagement_id}/context

Request

  • Base URL
    https://api.cloverhealth.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.cloverhealth.com/api/v1/external/engagements/{engagement_id}/context
  • Auth
    HTTP bearer

Path parameters

engagement_idstring uuid required

Response

OK

engagement_idstring uuid required
first_namestring nullable
last_namestring nullable
subscriber_idstring nullable
preferred_languagestring nullable
member_verifiedboolean nullable
intentstring nullable
master_record_idstring nullable
support_teamstring nullable
categorystring nullable
mx_agentboolean nullable
lh_balanceboolean nullable
member_preferred_buddystring nullable
member_preferred_buddy_worker_sidstring nullable
member_preferred_buddy_matchedstring nullable

Changes