API Overview

Learn more about the Referral Exchange APIs and discover APIs easily.

API Endpoint NameShort DescriptionLink
List referralsFetches a list of referrals created by the sender, with pagination for large datasets.View
Get referral detailsRetrieves the complete details and metadata for a specific referral.View
Get action link by typeFetches a fresh, one-time referral link URL for a specific action type on a referral.View
Delete a draft referralDeletes a referral that is still in draft and not yet submitted.View
Cancel a referralCancels a referral that has already been submitted but not yet confirmed.View
Convert a referral to draftConverts a submitted referral back into draft status for modification.View
Create a new referral linkGenerates a unique referral link for email or system-based referral submissions.View