Referral

Get Referrals

Fetch all referral summaries for the current user.

This endpoint queries the referrals collection for documents where the referrer_id matches the current user's ID. For each referral, it looks up the referred user's email using the referred_id, and returns a list of summaries containing the referred email and the referral status.

Returns: List[ReferralSummary]: A list of referral summary objects.

get/referral/all

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/referral/all
  • Auth: OAuth 2 (password, token URL api/login)

Response

Successful Response

referred_emailstring email required
status'pending' | 'done' required

Changes

No operation changes recorded.