Referrals (v1)

This section documents all referral management endpoints for workspaces.

Overview

Referrals allow workspaces to manage a list of referral contacts with their contact information including name, optional email, phone number, and optional WhatsApp number.

Endpoints

• List Referrals - Get a paginated list of referrals with optional search
• Get Referral - Get a single referral by ID
• Create Referral - Create a new referral
• Update Referral - Update an existing referral
• Delete Referral - Delete a referral
• List Referral Lab Visits - List lab visits associated with a referral

Authentication

All endpoints require workspace authentication. See Authentication for details.

Common Features

• Search: Search referrals by name, email, phone, or WhatsApp number
• Pagination: All list endpoints support pagination with page and limit parameters
• Email Uniqueness: If provided, each referral email must be unique within a workspace