Skip to main content
GET
List active campaigns

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._:-]*$

Query Parameters

limit
integer
default:20

Maximum number of rows to return.

Required range: x <= 100
offset
integer
default:0

Pagination offset.

Required range: 0 <= x <= 9007199254740991
chainId
integer

Reward chain ID.

Required range: x <= 9007199254740991
targetChainId
integer

Event chain ID. Must be provided with targetAddress.

Required range: x <= 9007199254740991
targetAddress
string

Event-chain target vault, pool, or token address.

userAddress
string

User EVM address. Responses normalize addresses to lowercase.

budget
string

Campaign budget address.

claimable
enum<string>

When true, requires userAddress and returns campaigns with unclaimed rewards.

Available options:
true,
false
includeForwarderRequired
enum<string>

Opt in to campaigns that require deposits through a forwarder.

Available options:
true,
false

Response

Active campaign page

data
object[]
required
total
integer
required
Required range: 0 <= x <= 9007199254740991