POST
/
offering
/
offer
/
get-offers
curl --request POST \
  --url https://api-sandbox.appcharge.com/offering/offer/get-offers \
  --header 'x-publisher-token: <x-publisher-token>'
{
  "result": {
    "totalCount": 123,
    "offers": [
      {
        "offerId": "<string>",
        "publisherOfferId": "<string>",
        "name": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "type": "<string>",
        "createdBy": "<string>",
        "offerUi": {
          "offerUiId": "<string>",
          "externalId": "<string>",
          "active": true,
          "offerUiType": "<string>",
          "name": "<string>",
          "description": "<string>",
          "backgroundImage": "<string>",
          "specialOffer": {
            "templateType": "<string>",
            "presentOfferEndTimer": true,
            "title": "<string>",
            "fontSize": 123,
            "fontWeight": "<string>",
            "fontColor": {
              "colorOne": "<string>",
              "colorTwo": "<string>",
              "direction": "<string>"
            },
            "backgroundColor": {
              "colorOne": "<string>",
              "colorTwo": "<string>",
              "direction": "<string>"
            }
          }
        },
        "dynamicOfferUi": {
          "badges": [
            {
              "publisherBadgeId": "<string>",
              "position": "<string>"
            }
          ],
          "salePercentage": 123,
          "salePercentageDisplayType": "percentage"
        },
        "active": true,
        "segments": [
          "<string>"
        ],
        "productsSequence": [
          {
            "index": 123,
            "playerAvailability": 123,
            "priceInUsdCents": 123,
            "products": [
              {
                "quantity": 123,
                "product": {
                  "publisherProductId": "<string>",
                  "name": "<string>",
                  "textFontColorHex": "<string>",
                  "type": "<string>",
                  "prefix": "<string>",
                  "suffix": "<string>",
                  "priority": "<string>",
                  "images": [
                    {
                      "type": "<string>",
                      "url": "<string>"
                    }
                  ],
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z",
                  "productId": "<string>"
                }
              }
            ]
          }
        ],
        "startOver": true,
        "priority": 123,
        "showAfter": "<string>",
        "triggers": [
          {
            "type": "<string>",
            "eventName": "<string>",
            "every": 123,
            "rules": [
              "<any>"
            ]
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "status": 123,
  "message": "<string>"
}

Headers

​
x-publisher-token
string
required

The publisher token

Query Parameters

​
offerType
string

Bundle, SpecialOffer, Popup

​
recordLimit
number

Record limit (0-500). Defaults to 100 if not defined.

Required range: 0 <= x <= 500
​
offset
number

Offset (non-negative value).

Required range: x >= 0
​
publisherOfferId
string

To retrieve specific offers. If adding multiple, use ',' to separate.

Response

200
application/json

Get all offers

The response is of type object.