Get Campaign By ID

GET

/campaigns

Last modified:2025-12-30 08:56:45

Retrieve detailed information about a specific campaign using its unique identifier.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/campaigns?campaignId=f7a3b9e1-4c2d-4a8f-9e3b-1d5c7a8b9f0e' \
--header 'x-auth-referralstack: rs_live_e6761c15744c9be53be18802278fd3da751d03de'

Responses

🟢200Success

application/json

Body

Example

{
  "status": 200,
  "message": "Campaign fetched successfully",
  "data": {
    "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!",
    "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"
  }
}

🟠401Unauthorized (Missing API Key)

🟠400Bad Request (Missing campaignId)

Modified at 2025-12-30 08:56:45

Get All Campaigns

Create campaign