Get All Campaigns - ReferralStack

Retrieve a paginated list of all campaigns associated with the authenticated user's account.

This endpoint returns campaign details including commission structures, payout terms, and configuration settings. Results can be filtered by workspace and sorted by various criteria.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "message": "Campaigns fetched successfully",
    "data": {
        "items": [
            {
                "id": "f7a3b9e1-4c2d-4a8f-9e3b-1d5c7a8b9f0e",
                "campaignName": "Summer Product Launch 2025",
                "commissionType": "percentage",
                "amount": 15,
                "minimumPayoutAmount": 50,
                "payoutId": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6",
                "workspaceId": "w9x8y7z6-v5u4-t3s2-r1q0-p9o8n7m6l5k4",
                "requiresApprovalToJoin": true,
                "collectAdditionalInfo": true,
                "hideCustomerEmail": false,
                "payoutTerm": 45,
                "url": "https://example.com/summer-launch",
                "affiliatePortalWelcomeMessage": "Welcome to our Summer Campaign! Earn 15% on every sale.",
                "affiliateDashboardText": "Track your summer campaign performance here.",
                "stripeCouponId": "SUMMER2025",
                "allowedUrlParameters": [
                    "utm_source",
                    "utm_campaign",
                    "ref"
                ],
                "isDefault": false,
                "createdAt": "2025-05-01T10:00:00.000Z",
                "updatedAt": "2025-06-15T14:30:00.000Z"
            },
            {
                "id": "e8d4c2b1-9a7f-4e6d-8c5b-3a2f1e0d9c8b",
                "campaignName": "Default Referral Program",
                "commissionType": "fixed",
                "amount": 50,
                "minimumPayoutAmount": 100,
                "payoutId": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6",
                "workspaceId": "w9x8y7z6-v5u4-t3s2-r1q0-p9o8n7m6l5k4",
                "requiresApprovalToJoin": false,
                "collectAdditionalInfo": false,
                "hideCustomerEmail": false,
                "payoutTerm": 30,
                "url": "https://example.com",
                "affiliatePortalWelcomeMessage": "Thank you for joining our affiliate program!",
                "affiliateDashboardText": "Your default campaign dashboard.",
                "stripeCouponId": null,
                "allowedUrlParameters": null,
                "isDefault": true,
                "createdAt": "2025-01-01T00:00:00.000Z",
                "updatedAt": "2025-01-01T00:00:00.000Z"
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 25,
            "total": 2,
            "totalPages": 1
        }
    }
}

🟠401Unauthorized (Missing API Key)

🟠403Forbidden (Incorrect WorkspaceId)