Giveaways

curl --get "$BASE/api/v1/giveaways/flow" \
  -d "id=123" \
  -d "user=user-123" \
  --header "X-API-Key: $KEY"

const url = new URL(`${BASE}/api/v1/giveaways/flow`);
url.search = new URLSearchParams({
  id: "123",
  user: "user-123",
});

const res = await fetch(url, {
  headers: { "X-API-Key": KEY },
});

{
  "success": true,
  "data": {
    "id": "123",
    "name": "Summer giveaway",
    "template": 1,
    "headerTemplate": 2,
    "header": { "title": "", "description": "", "steps": [] },
    "settings": {
      "ctaLabel": "Claim now",
      "ctaColor": "#ffffff",
      "ctaBg": "#4AAEAB",
      "headerBg": "#ffffff",
      "headerTextColor": "#000000",
      "sectionTitles": []
    },
    "logo": "https://…/logo.png",
    "offers": [
      {
        "id": "69c667633181fd52275838c2",
        "partner": "Advertiser",
        "partnerLogo": "https://…/partner-logo.png",
        "terms": "T&Cs apply. While stocks last.",
        "title": "Free Gift",
        "description": "Get your giveaway.",
        "image": "https://…/image.jpg",
        "squareImage": "https://…/square.jpg",
        "heroImage": "https://…/hero.jpg",
        "offerInfoButtonDescription": "Limited time offer",
        "expiry": null,
        "schedule": null
      }
    ]
  }
}

curl --get "$BASE/api/v1/giveaways/claim" \
  -d "user=user-123" \
  -d "offer=123" \
  --header "X-API-Key: $KEY"

const url = new URL(`${BASE}/api/v1/giveaways/claim`);
url.search = new URLSearchParams({
  user: "user-123",
  offer: "123",
});

const { success, data, message } =
  await (await fetch(url, {
    headers: { "X-API-Key": KEY },
  })).json();

{ "success": true, "data": { "code": "DEF456" } }

curl --get "$BASE/api/v1/giveaways/events" \
  -d "type=claim" \
  -d "start_date=2026-03-01" \
  -d "end_date=2026-03-07" \
  -d "page=1" \
  --header "X-API-Key: $KEY"

const url = new URL(`${BASE}/api/v1/giveaways/events`);
url.search = new URLSearchParams({
  type: "claim",
  start_date: "2026-03-01",
  end_date: "2026-03-07",
  page: "1",
});

const { data, pagination } =
  await (await fetch(url, {
    headers: { "X-API-Key": KEY },
  })).json();

{
  "success": true,
  "data": [
    {
      "id": "69c667643181fd52275838c5",
      "type": "claim",
      "timestamp": 1774879237696,
      "user": "user-123",
      "offer": "69c667633181fd52275838c2"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10000,
    "total": 1,
    "last_page": 1
  }
}