Skip to main content
GET
Get a campaign

Headers

X-Boost-Ref-Id
string

Optional partner attribution reference ID. Values are manually assigned by Boost and must be at most 128 characters.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$

Path Parameters

campaignId
string
required

Campaign ID in chainId:campaignIndex form, for example 480:1.

Pattern: ^\d+:\d+$

Query Parameters

userAddress
string

User EVM address. Responses normalize addresses to lowercase.

Response

Campaign

id
object
required
tvl
string
required
Pattern: ^(0|[1-9]\d*)$
participants
integer
required
Required range: 0 <= x <= 9007199254740991
rewardsDistributed
string
required
Pattern: ^(0|[1-9]\d*)$
rewardsRemaining
string
required
Pattern: ^(0|[1-9]\d*)$
boostApyBps
string | null
required
Pattern: ^(0|[1-9]\d*)$
protocolApyBps
string | null
required
Pattern: ^(0|[1-9]\d*)$
eventChainId
integer
required
Required range: x <= 9007199254740991
configHash
any
required
status
enum<string>
required
Available options:
draft,
pending,
active,
ended,
finalized,
cancelled
startTime
string
required
Pattern: ^(0|[1-9]\d*)$
endTime
string
required
Pattern: ^(0|[1-9]\d*)$
rewardToken
object
required
totalRewards
string
required
Pattern: ^(0|[1-9]\d*)$
target
object
required
modes
object
required
requiresForwarderDeposit
boolean
required
userPosition
object | null
required