API Overview
Learn more about the Referral Exchange APIs and discover APIs easily.
| API Endpoint Name | Short Description | Link |
|---|---|---|
| List referrals | Fetches a list of referrals created by the sender, with pagination for large datasets. | retrieving-referrals/list-by-institution |
| Get referral details | Retrieves the complete details and metadata for a specific referral. | retrieving-referrals/get |
| Delete a draft referral | Deletes a referral that is still in draft and not yet submitted. | updating-referrals/delete |
| Cancel a referral | Cancels a referral that has already been submitted but not yet confirmed. | updating-referrals/cancel |
| Convert a referral to draft | Converts a submitted referral back into draft status for modification. | updating-referrals/back-to-draft |
| Create a new referral link | Generates a unique referral link for email or system-based referral submissions. | creating-referrals/create-upsert-link |
