Campaigns

Campaigns are point-based programs used to incentivize user activities on Pareto. Users can earn points by interacting with vaults or participating in social activities.

Structure

Each campaign object includes:

• _id (string) — Unique identifier

• code (string) — Campaign code

• name (object) — Multilingual name, e.g. { en: "My Campaign" }

• description (object) — Multilingual description

• rules (array) — Conditions for earning points:

  • name, description (object) — i18n fields

  • trigger (string) — DEPOSIT or DEPOSIT_REQUEST

  • deposit (object) —

    • type: BALANCE or AGE

    • value: number

  • reward (object) —

    • type: AMOUNT or MULTIPLIER

    • value: number

  • frequency (object) — repetition rules (value, unit)

• referrals (array) — Invite codes with activation flag

• startDate / endDate (string) — ISO datetime

• link (string) — URL

• galxeId (number) — External reference

• createdAt, updatedAt (string) — ISO timestamp

• createdBy, updatedBy (string) — Actor IDs

Endpoints

List all campaigns

get

Responses

200

A list of campaigns

application/json

get

HTTPcURLJavaScriptPython

GET /v1/campaigns HTTP/1.1
Host: api.pareto.credit
Accept: */*

200

A list of campaigns

{
  "data": [
    {
      "_id": "text",
      "code": "text",
      "name": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "description": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "rules": [
        {
          "name": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "description": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "trigger": "DEPOSIT",
          "deposit": {
            "type": "BALANCE",
            "value": 1
          },
          "reward": {
            "type": "AMOUNT",
            "value": 1
          },
          "frequency": {
            "value": 1,
            "unit": "seconds"
          }
        }
      ],
      "referrals": [
        {
          "code": "text",
          "isActive": true
        }
      ],
      "startDate": "2025-07-12T04:21:11.799Z",
      "endDate": "2025-07-12T04:21:11.799Z",
      "link": "text",
      "galxeId": 1,
      "createdAt": "2025-07-12T04:21:11.799Z",
      "createdBy": "text",
      "updatedAt": "2025-07-12T04:21:11.799Z",
      "updatedBy": "text"
    }
  ],
  "totalCount": 1
}

Get campaign by ID

get

Path parameters

campaignIdstringRequired

Responses

200

Campaign details

application/json

get

HTTPcURLJavaScriptPython

GET /v1/campaigns/{campaignId} HTTP/1.1
Host: api.pareto.credit
Accept: */*

200

Campaign details

{
  "_id": "text",
  "code": "text",
  "name": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "description": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "rules": [
    {
      "name": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "description": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "trigger": "DEPOSIT",
      "deposit": {
        "type": "BALANCE",
        "value": 1
      },
      "reward": {
        "type": "AMOUNT",
        "value": 1
      },
      "frequency": {
        "value": 1,
        "unit": "seconds"
      }
    }
  ],
  "referrals": [
    {
      "code": "text",
      "isActive": true
    }
  ],
  "startDate": "2025-07-12T04:21:11.799Z",
  "endDate": "2025-07-12T04:21:11.799Z",
  "link": "text",
  "galxeId": 1,
  "createdAt": "2025-07-12T04:21:11.799Z",
  "createdBy": "text",
  "updatedAt": "2025-07-12T04:21:11.799Z",
  "updatedBy": "text"
}