asclepius-payments

Hs Referral Prefill

What the /partner page needs to prefill itself. PUBLIC and unauthenticated.

This endpoint returns nothing the holder of the token was not already sent. The token arrives in the link inside their own introduction email, and everything below, their name, their address, their organization, their role, and the first name of the physician who introduced them, was in that email's body. The whole point is to save a CIO from retyping four fields we already know; it is not a lookup service.

Specifically NOT returned: the referrer's email address, their note, our enrichment, and every other row on hs_referrals. Built by whitelist.

An unknown token is a 200 with found: false, not a 404. A 404 makes this a membership oracle, feed it tokens and the status code tells you which ones are live. The page renders an ordinary empty form either way, which is exactly what it should do when someone follows a stale link.

status is advanced to opened as a side effect, which is what makes the referring physician's funnel row move on its own.

get/api/asclepius/hs-referral/{token}

Request

  • Base URL
    https://app.archangelhealth.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://app.archangelhealth.ai/api/asclepius/hs-referral/{token}
  • Auth
    none declared

Path parameters

tokenstring required

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.