Get a paginated list of premiums. | Virtuous Developer Documentation

{
  "items": [
    {
      "id": 1024,
      "currency": "USD",
      "name": "Eco-Friendly Water Bottle",
      "nameShort": "Water Bottle",
      "code": "ECO-WB-2024",
      "description": "Reusable water bottle made from sustainable materials, perfect for everyday use.",
      "isActive": true,
      "price": 19.99,
      "formattedPrice": "$19.99",
      "fairMarketValue": 25,
      "formattedFairMarketValue": "$25.00",
      "inventory": 150,
      "keepActiveWhenHasNoInventory": false,
      "recurringPremiumId": 2048,
      "recurringPremiumName": "Monthly Eco Pack",
      "image": "https://cdn.raisedonors.com/images/premiums/eco-water-bottle.jpg",
      "externalIdentifier": "PREM-2024-0001",
      "otherMinimumAmounts": [
        {
          "currency": "USD",
          "value": 15
        },
        {
          "currency": "EUR",
          "value": 13.5
        }
      ]
    }
  ],
  "total": 1
}

Authentication

Authorizationstring

JWT Authorization header using the Bearer scheme. Example: “Authorization: Bearer {token}”

Query parameters

FilterstringOptional

SkipintegerOptional

TakeintegerOptional

SortByenumOptional

Field to sort by (case-insensitive). Valid options: fmv, id, status

Allowed values:

DescendingbooleanOptional

IncludeDetailsbooleanOptional

Response

itemslist of objectsOptional

totalintegerOptional

Errors

400

Bad Request Error