v1.0.0
OAS 3.0.1

LoyaltyCore Management API V1.0.0

API Version 1.0.0

Development Server

Client Libraries

Campaigns

Get campaigns

Responses
Request Example forGET/api/v1/Campaigns
curl https://loyalty-core-management-api-dev.n1co.com/api/v1/Campaigns \
  --header 'X-Api-Key: YOUR_SECRET_TOKEN'
{
  "campaigns": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "integrationId": null,
      "name": null,
      "description": null,
      "userEventFrequency": "Daily",
      "userEventFrequencyLimit": null,
      "eventCost": null,
      "extraAttemptCost": null,
      "endDate": null,
      "startDate": null,
      "state": "Disabled",
      "imageUrl": null,
      "order": null,
      "features": [
        "RewardByProbability"
      ],
      "metadata": null,
      "couponSettings": {
        "pattern": null,
        "validCharacters": [
          "…"
        ]
      },
      "referralSettings": {
        "pattern": null,
        "validCharacters": [
          "…"
        ]
      },
      "storeIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "segmentIds": [
        1
      ]
    }
  ]
}

LoyaltyPrograms (Collapsed)

Loyalty Programs Controller

Models