# 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

{% openapi src="<https://4223418165-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVSPclqPyChB4NMxFfG2X%2Fuploads%2F4omDdrMriuCBYpOfBwTM%2FCampaigns.yaml?alt=media&token=22cb65cd-d3ea-4aeb-9e98-879cafedddaa>" path="/campaigns" method="get" %}
[Campaigns.yaml](https://4223418165-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVSPclqPyChB4NMxFfG2X%2Fuploads%2F4omDdrMriuCBYpOfBwTM%2FCampaigns.yaml?alt=media\&token=22cb65cd-d3ea-4aeb-9e98-879cafedddaa)
{% endopenapi %}

{% openapi src="<https://4223418165-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVSPclqPyChB4NMxFfG2X%2Fuploads%2F4omDdrMriuCBYpOfBwTM%2FCampaigns.yaml?alt=media&token=22cb65cd-d3ea-4aeb-9e98-879cafedddaa>" path="/campaigns/{campaignId}" method="get" %}
[Campaigns.yaml](https://4223418165-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVSPclqPyChB4NMxFfG2X%2Fuploads%2F4omDdrMriuCBYpOfBwTM%2FCampaigns.yaml?alt=media\&token=22cb65cd-d3ea-4aeb-9e98-879cafedddaa)
{% endopenapi %}