Get All Referred Users

GET

/referred-users/list

Last modified:2025-12-30 09:17:11

Retrieves a paginated list of all users who were referred through affiliate campaigns.

This endpoint allows filtering by specific campaign ID or affiliate ID, and supports sorting by various fields such as creation date. Use this to track and manage referred users across your affiliate program.

Request

Header Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/referred-users/list' \
--header 'x-auth-referralstack: rs_live_e6761c15744c9be53be18802278fd3da751d03ce' \
--form 'page="1"' \
--form 'limit="50"' \
--form 'campaignId="8b9cd67a-bc33-468f-bf31-2c3d25f56748"' \
--form 'affiliateId="d3a1153d-cb87-4644-8429-7ecf1a7c3257"' \
--form 'orderType="createdAt"' \
--form 'orderValue="ASC or DESC"' \
--form 'workspaceId="5bb8cbe6-67dc-4b07-853e-7ca5454f8515"' \
--form 'contains="john@example.com"'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "Referred users fetched successfully",
    "data": {
        "items": [
            {
                "commissionId": "29e62a66-ab83-4412-ad3e-0ce6d1392461",
                "referredUser": "john@example.com",
                "affiliateId": "05ddfd92-1abe-41e6-8bad-467256954bc6",
                "workspaceId": "5bb8cbe6-67dc-4b07-853e-7ca5454f8512",
                "campaignId": "8b9cd67a-bc33-468f-bf31-2c3d25f56748",
                "amount": "120.00",
                "adminEarnedAmount": "0.00",
                "status": "paid",
                "payoutDate": null,
                "name": "Demo Referral",
                "remarks": "Admin manually marked as paid",
                "isSelfReferral": false,
                "isWalletPayment": 0,
                "chargeId": null,
                "invoiceId": null,
                "stripeSubscriptionId": null,
                "createdAt": "2025-11-12T09:01:37.120Z",
                "updatedAt": "2025-12-29T03:40:17.786Z"
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 25,
            "total": 6,
            "totalPages": 1
        }
    }
}

🟠400Bad request

🟠401Unauthorized (Missing API Key)

Modified at 2025-12-30 09:17:11

Delete Commision

Get Referred User by Email