Campaigns

Campaigns are how your users can earn your $TOKEN in exchange for completing an action, or as we refer to them - incentive. Once a campaign is active, users can complete one or more incentives and earn your $TOKEN as a reward.

For more details, read our guide on rewarding your audience in exchange for completing an incentive.

The campaign object

This object represents a campaign. It lets you retrieve basic information about the campaign including supply remaining, status, start and end dates, and total number of participating users.

Retrieve campaign

Get status and information about a campaign

Get remaining supply, status, end date, etc, for a campaign

GEThttp://localhost:8080/v1/campaigns/{campaignId}

Path parameters

campaignId*string

Response

200404

Ok

Body

application/json

statusenum

CONFIGURINGRUNNINGPAUSED

periodStartstring (date)

periodEndstring (date)

supplynumber (double)

consumednumber (double)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/v1/campaigns/{campaignId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "status": "CONFIGURING",
  "periodStart": "2024-12-21",
  "periodEnd": "2024-12-21",
  "supply": 0,
  "consumed": 0
}