GET /api/v4/campaigns/:id
Get campaign by ID

Success response body

{
  "id": ID
  "name": "NAME CAMPAIGN",
  "hex_code": "HEX CODE",
  "details": "DESCRIPTION",
  "cover_image_s3_key": "IMAGE URL",
  "logo_s3_key": "LOGO URL",
  "video_url": "VIDEO URL",
  "date_from": "2023-05-30T00:00:00.000Z",
  "date_to": "2024-05-30T00:00:00.000Z",
  "goal_amount": GOAL AMOUNT,
  "prices": [
    {
      "value": 50,
      "price_id": "price_1NMKX5Axd7UNEmWNLHhIib9D"
    },
    {
      "value": 100,
      "price_id": "price_1NMKX6Axd7UNEmWNEGsNk2Gn"
    },
    {
      "value": 150,
      "price_id": "price_1NMKX6Axd7UNEmWNwASKiU2o"
    },
    {
      "value": 200,
      "price_id": "price_1NMKX6Axd7UNEmWNwbeBkE4U"
    },
    {
      "value": 250,
      "price_id": "price_1NMKX7Axd7UNEmWNu8Nkitxp"
    },
    {
      "value": 0,
      "price_id": null
    }
  ],
  "sponsor_price_id": "price_1NNf81Axd7UNEmWNI7yAgfeA",
  "total_raised": 2006.19,
  "status": "live",
  "sponsorship_opportunity": "SPONSORSHIP OPPORTUNITY",
  "workspace_id": WORKSPACE_ID,
  "workspace_name": "WORKSPACE NAME",
  "tax_deductible": true,
  "tax_id": "123",
  "multi_sport": true,
  "disable_sponsor": false,
  "sponsors_logo": [
      "0023994DF41808A6AE5E1C8B11ABFFAE.png",
      "0023994DQQQ548A6AE5E1C8B11ABFFAE.png"
  ],
  "sports": [
    {
      "id": 1,
      "title": "Sport Football",
      "details": "Lorem ipsum detatils",
      "full_description": "Lorem ipsum full description",
      "cover_image_s3_key": "test.jpg",
      "image_s3_key": "test2.jpg",
      "video_url": "https://youtube.com"
    }...,
  ],
  "donor_metrics": [
    {
      "id": 1,
      "name": "John Smith",
      "email": "john@scrumlaunch.com",
      "donation_amount": 500.0,
      "anonymous": true,
      "campaign_id": 1,
      "campaign_name": "Campaign 1",
      "status_payment": 1,
    }...,
  ]
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer