For AI agents: a documentation index is available at the root level at /llms.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
Concepts
API Reference

About the Referral Exchange (RefX)
API Overview
Accessing our APIs
Authentication
Content Types
Request and Response Limits
Quickstart
Create and Edit Referrals
Print Referrals
List Referrals
Cancel & Withdraw Referrals
Timeline Events
Offerings
Referral Lifecycle & Statuses
Referral Notes
Browser Tab Handling
Referral Link
Subsidy and medical eligibility
Retrieves a paginated list of referrals
Create a new referral
Retrieves a paginated list of referrals by institution
Full details for a referral
Delete a draft referral
Cancel a referral
Amend and resubmit a pending referral
Accept
Reject
Convert a referral to draft
Create a note for a referral
List referrers with whitelisting status
List all referral destinations
Get the recommended offering for a category based on postal code
List 5 timeslots for a referral destination
Create a new referral link
Fetches one referral
For processing encrypted FormSG webhooks
For processing encrypted FormSG webhooks
Check

API Reference Health

Check

GET

/api/v1/health

GET

/api/v1/health

$ curl https://dummy-url-see-smartcms-spec/api/v1/health

200Retrieved

1 {
2   "status": "ok"
3 }

Response

Health check

statusenum

Was this page helpful?