GET
/
campaigns
curl --request GET \
  --url https://api-dev.withflock.com/campaigns \
  --header 'Authorization: <api-key>'
[
  {
    "name": "<string>",
    "refereeLandingPageUrl": {},
    "termsUrl": {},
    "proposedRewardTrigger": {},
    "manualRewardTrigger": {},
    "inviteMessage": {},
    "isLive": true,
    "isDefault": true,
    "environment": "production",
    "copiedFromCampaignId": {},
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": {},
    "organizationId": "<string>",
    "applicationId": "<string>",
    "lastPingAt": {},
    "lastPingOrigin": {},
    "rewards": [
      {
        "name": {},
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": {},
        "organizationId": "<string>",
        "applicationId": "<string>",
        "limit": {},
        "type": "payout",
        "campaignId": "<string>",
        "description": {},
        "party": "referrer",
        "method": "paypal",
        "payoutAmount": {},
        "discountAmount": {},
        "discountPercentage": {},
        "discountDurationInMonth": {},
        "currency": "usd",
        "limitUnit": {},
        "limitInterval": {},
        "disabled": true
      }
    ],
    "emails": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": {},
        "organizationId": "<string>",
        "applicationId": "<string>",
        "message": "<string>",
        "type": "referrer:reward",
        "campaignId": "<string>",
        "subjectLine": "<string>",
        "buttonText": "<string>",
        "buttonColor": "<string>",
        "logoUrl": {},
        "logoSize": {}
      }
    ],
    "campaignPages": [
      {
        "path": "<string>",
        "id": "<string>",
        "isEmpty": true,
        "name": {},
        "placementId": {},
        "platform": {}
      }
    ],
    "faqs": [
      {}
    ],
    "platforms": [
      "mobile"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
environment
enum<string>

Filter campaigns by environment

Available options:
production,
test
​
isLive
boolean

Filter live campaigns only

​
isDefault
boolean

Filter default campaigns only

​
orderBy
object

Sorting criteria. Available options: createdAt

​
orderDirection
object

Sorting direction. Available options: asc, desc

Response

200 - application/json

The response is of type object[].