Get Referred User by Email

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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