Skip to main content

​
Get details for a single campaign, structured as offer groups → tiers → offers, plus redemption locations.

​
Required Scopes: campaigns:read

​
ok
boolean
true on success
​
creatorId
string (uuid)
Echoed back
​
campaign
object

child attributes

​
brand.imageUrl
string (url)
Brand logo
​
status
string
AVAILABLE, ACTIVATED, or ENDED (creator’s status)
​
active
boolean
Whether the brand currently has the campaign live
​
startsAt
string (date)
YYYY-MM-DD
​
endsAt
string (date) | null
null = open-ended
​
imageUrl
string (url)
Campaign hero image
​
offerGroups
object array

child attributes

​
status
string
ACTIVE, PAUSED, DRAFT, or INACTIVE
​
anyLocation
boolean
true = valid at all of the brand’s locations
​
tiers
object array

child attributes

​
tierNum
number
1-based tier position
​
name
string | null
Display name; fall back to Tier {tierNum}
​
checkInType
string
LOCATION, NONE, CODE, or QR_CODE
​
offers
object array

child attributes

​
value
number
Cents when redemptionType is PAID; whole dollars (estimated value) for gifted offers
​
redemptionType
string
VOUCHER_SCREEN (collab pass), PROMO_CODE, or PAID
​
instructions
string | null
Redemption instructions for the creator
​
locations
object array

child attributes

​
address
string
Full street address
​
mapTileUrl
string (url)
Static map preview image
bash
curl -sS https://api.storytime.io/v1/creators/<creatorId>/campaigns/<campaignId> \
  -H "Authorization: Bearer pk_live_xxxxxxxxxxxxxxxxxxxxxxxx"
200
{
  "ok": true,
  "creatorId": "7d4e2a10-0000-4000-8000-000000000101",
  "campaign": {
    "id": "0b1f3d3e-4c1a-4a5e-9b6a-000000000001",
    "name": "Summer Tasting Menu",
    "description": "Join us for our new summer tasting menu — a five-course seasonal experience. Share your visit in a Reel or carousel and tag us.",
    "brand": {
      "id": "a9c8b7d6-0000-4000-8000-000000000201",
      "name": "Marlow & Vine",
      "imageUrl": "https://cdn.storytime.io/uploads/demo-brand-marlow.jpg"
    },
    "status": "AVAILABLE",
    "active": true,
    "startsAt": "2026-07-01",
    "endsAt": "2026-07-31",
    "imageUrl": "https://cdn.storytime.io/uploads/demo-summer-tasting.jpg",
    "offerGroups": [
      {
        "id": "d1e2f3a4-0000-4000-8000-000000000401",
        "name": "West Village Dinner",
        "status": "ACTIVE",
        "anyLocation": false,
        "tiers": [
          {
            "id": "c1d2e3f4-0000-4000-8000-000000000501",
            "tierNum": 1,
            "name": "Standard",
            "checkInType": "LOCATION",
            "offers": [
              {
                "id": "b1c2d3e4-0000-4000-8000-000000000601",
                "description": "Five-course summer tasting menu for two",
                "value": 150,
                "redemptionType": "VOUCHER_SCREEN",
                "instructions": "Show your collab pass to the host when you arrive."
              }
            ]
          }
        ],
        "locations": [
          {
            "id": "f1a2b3c4-0000-4000-8000-000000000701",
            "name": "Marlow & Vine",
            "address": "21 Grove St, New York, NY 10014",
            "lat": 40.7331,
            "long": -74.0037,
            "mapTileUrl": "https://cdn.storytime.io/uploads/demo-map-marlow-grove.png"
          }
        ]
      }
    ]
  }
}