For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Home
    • About the Referral Exchange (RefX)
  • Getting Started
    • API Overview
    • Accessing our APIs
    • Authentication
    • Content Types
    • Request and Response Limits
    • Create and Edit Referrals
    • Print Referrals
    • List Referrals
    • Cancel & Withdraw Referrals
    • Timeline Events
    • Implementation Reference
  • Concepts
    • Referral Lifecycle & Statuses
    • Referral Notes
    • Browser Tab Handling
    • Referral Link
    • NEHR Integration
  • API Reference
    • Changelog
LogoLogo
Getting Started

API Overview

Was this page helpful?
Previous

Accessing our APIs

Next
Built with

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