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

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

Authorizations

oAuthtokenIdHeader

OAuth2clientCredentialsRequired

Token URL:

Path parameters

campaignIdstringRequired

Responses

200

Ok

application/json

statusstring · enumOptionalPossible values:

periodStartstring · dateOptional

periodEndstring · dateOptional

supplynumber · doubleOptional

consumednumber · doubleOptional

404

Campaign not found

get

/campaigns/{campaignId}

HTTPcURLJavaScriptPython

GET /v1/campaigns/{campaignId} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "status": "CONFIGURING",
  "periodStart": "2026-03-05",
  "periodEnd": "2026-03-05",
  "supply": 1,
  "consumed": 1
}