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.https://docs.refer.health.gov.sg/api-reference/referrals/list
Get referral detailsRetrieves the complete details and metadata for a specific referral.https://docs.refer.health.gov.sg/api-reference/referrals/get
Delete a draft referralDeletes a referral that is still in draft and not yet submitted.https://docs.refer.health.gov.sg/api-reference/referrals/delete
Cancel a referralCancels a referral that has already been submitted but not yet confirmed.https://docs.refer.health.gov.sg/api-reference/referrals/cancel
Convert a referral to draftConverts a submitted referral back into draft status for modification.https://docs.refer.health.gov.sg/api-reference/referrals/back-to-draft
Create a new referral linkGenerates a unique referral link for email or system-based referral submissions.https://docs.refer.health.gov.sg/api-reference/links/create-upsert-link