TokenOS
  • Overview
    • Introduction
    • Authentication
    • User & Wallet Identification
    • Errors
    • Versioning
  • Guides
    • How our system works
    • Rewarding your audience
      • In exchange for completing an incentive
      • In exchange for your own points
      • As a credit
  • Wallet API
    • Balances
    • Allocations
  • Management API
    • Token Selection
    • Campaigns
    • Subscriptions
    • Codes
  • Payments API
    • Introduction
    • Payments
    • Deliveries
    • Relayer
Powered by GitBook
On this page
  1. Management API

Campaigns

PreviousToken SelectionNextSubscriptions

Last updated 2 years ago

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
Path parameters
campaignIdstringRequired
Responses
200
Ok
application/json
404
Campaign not found
get
GET /v1/campaigns/{campaignId} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "status": "CONFIGURING",
  "periodStart": "2025-06-22",
  "periodEnd": "2025-06-22",
  "supply": 1,
  "consumed": 1
}
  • The campaign object
  • Retrieve campaign
  • GETGet status and information about a campaign