Getting StartedAPI Reference
Getting StartedAPI Reference
Help Center
Login
  1. Referred Users
  • Campaigns
    • Get All Campaigns
      GET
    • Get Campaign By ID
      GET
    • Create campaign
      POST
    • Update campaign
      PUT
    • Delete campaign
      DELETE
  • Affiliates
    • List affiliates
      GET
    • Get Affiliate By ID
      GET
    • Create Affiliate
      POST
    • Update Affiliate
      PUT
    • Delete Affiliate
      DELETE
  • Affiliate Links
    • Get Affiliate Link By Affiliate ID
      GET
    • Create Affiliate Link
      POST
    • Delete Affiliate Link
      DELETE
  • Comissions
    • Get All Commissions
      GET
    • Get Commission By ID
      GET
    • Create Commision
      POST
    • Update Commision
      PUT
    • Delete Commision
      DELETE
  • Referred Users
    • Get All Referred Users
      GET
    • Get Referred User by Email
      GET
    • Create Referred User
      POST
    • Update Referred User
      PUT
    • Delete Referred User
      DELETE
Getting StartedAPI Reference
Getting StartedAPI Reference
Help Center
Login
  1. Referred Users

Get Referred User by Email

GET
/referred-users
Last modified:2025-12-30 10:44:02
Retrieves detailed information about a specific referred user by their email address.
This endpoint is useful for looking up individual referral records, verifying if a user was referred through your affiliate program, and accessing their referral details including the referring affiliate and campaign information.

Request

Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/referred-users?referredUser=john@example.com' \
--header 'x-auth-referralstack: rs_live_e6761c15744c9be53be18802278fd3da751d03ce'

Responses

🟢200Success
application/json
Body

Example
{
    "status": 200,
    "message": "Referred user fetched successfully",
    "data": {
        "commissionId": "2904f2be-8ae1-4f14-a66e-37d613eefc3f",
        "referredUser": "chandra.rupam@gmail.com",
        "affiliateId": "97592cb3-e1fc-4b8d-8af2-277b95454d08",
        "workspaceId": "5bb8cbe6-67dc-4b07-853e-7ca5454f8512",
        "campaignId": "9112d17b-0c77-45ab-a82f-f963f135b63d",
        "amount": "8.85",
        "adminEarnedAmount": "59.00",
        "status": "pending",
        "payoutDate": "2025-07-24T06:46:10.413Z",
        "name": null,
        "remarks": null,
        "isSelfReferral": false,
        "isWalletPayment": 0,
        "chargeId": null,
        "invoiceId": null,
        "stripeSubscriptionId": null,
        "createdAt": "2025-09-15T03:37:55.000Z",
        "updatedAt": "2025-10-16T05:18:54.225Z"
    }
}
🟠400Bad request (Missing Email)
🟠401Unauthorized (Missing API Key)
🟠404Not Found
Modified at 2025-12-30 10:44:02
Previous
Get All Referred Users
Next
Create Referred User
Built with