Getting StartedAPI Reference
Getting StartedAPI Reference
Help Center
Login
  1. Affiliates
  • 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. Affiliates

List affiliates

GET
/affiliates/list
Last modified:2025-12-29 12:27:04
Retrieves a paginated list of all affiliates.
Results can be filtered, searched, and sorted using optional query parameters such as workspace ID, search keywords, and ordering preferences. Pagination parameters allow efficient navigation through large datasets.

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 '/affiliates/list?page=1&limit=50&contains=john@example.com&workspaceId=5bb8cbe6-67dc-4b07-853e-7ca5454f8515&orderType=createdAt&orderValue=ASC or DESC' \
--header 'x-auth-referralstack: rs_live_e6761c15744c9be53be18802278fd3da751d03ce'

Responses

🟢200Success
application/json
Body

Example
{
  "status": 200,
  "message": "Affiliates fetched successfully",
  "data": {
    "items": [
      {
        "id": "af1c9d21-3b4e-4f1a-9c12-9a1e2f3d4b5c",
        "email": "john.doe@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "notes": "High conversion affiliate",
        "workspaceId": "ws_12345678-abcd-4efg-9012-abcdef123456",
        "campaignId": "cmp_98765432-aaaa-bbbb-cccc-1234567890ab",
        "payoutEmail": "john.payout@example.com",
        "payoutMethod": "PAYPAL",
        "details": "Promotes via blogs and newsletters",
        "isActive": true,
        "isBanned": false,
        "totalOpens": 320,
        "totalClicks": 145,
        "totalSignups": 27,
        "totalEarnings": 812.50,
        "createdAt": "2025-10-01T08:15:22.120Z",
        "updatedAt": "2025-12-01T10:45:11.781Z"
      },
      {
        "id": "bf2d8a44-91a0-4f72-bc99-3f45e6a7b890",
        "email": "jane.smith@example.com",
        "firstName": "Jane",
        "lastName": "Smith",
        "notes": "New affiliate",
        "workspaceId": "ws_12345678-abcd-4efg-9012-abcdef123456",
        "campaignId": "cmp_11223344-dddd-eeee-ffff-0987654321cd",
        "payoutEmail": "jane.payout@example.com",
        "payoutMethod": "WISE",
        "details": null,
        "isActive": true,
        "isBanned": false,
        "totalOpens": 45,
        "totalClicks": 12,
        "totalSignups": 3,
        "totalEarnings": 54.00,
        "createdAt": "2025-11-20T14:05:44.903Z",
        "updatedAt": "2025-12-10T09:30:01.221Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "total": 2,
      "totalPages": 1
    }
  }
}
🟠401Unauthorized (Missing API Key)
Modified at 2025-12-29 12:27:04
Previous
Delete campaign
Next
Get Affiliate By ID
Built with