GET
/
v2
/
offer
cURL
curl --request GET \
  --url https://api-sandbox.appcharge.com/v2/offer \
  --header 'x-publisher-token: <x-publisher-token>'
{
  "offers": [
    {
      "offerId": "<string>",
      "publisherOfferId": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "type": "<string>",
      "offerUi": {
        "offerUiId": "<string>",
        "externalId": "<string>",
        "active": true,
        "offerUiType": "<string>",
        "name": "<string>",
        "description": "<string>",
        "backgroundImage": "<string>",
        "specialOffer": {
          "templateType": "<string>",
          "title": "<string>",
          "fontSize": 123,
          "fontWeight": "<string>",
          "fontColor": {
            "colorOne": "<string>",
            "colorTwo": "<string>",
            "direction": "<string>"
          },
          "backgroundColor": {
            "colorOne": "<string>",
            "colorTwo": "<string>",
            "direction": "<string>"
          }
        }
      },
      "badges": [
        {
          "publisherBadgeId": "<string>"
        }
      ],
      "productSale": {
        "sale": 123,
        "type": "percentage"
      },
      "priceDiscount": {
        "discount": 123,
        "type": "percentage"
      },
      "active": true,
      "segments": [
        "<string>"
      ],
      "productsSequence": [
        {
          "index": 123,
          "playerAvailability": 123,
          "priceInUsdCents": 123,
          "products": [
            {
              "quantity": 123,
              "priority": "<string>",
              "product": {
                "publisherProductId": "<string>",
                "name": "<string>",
                "textFontColorHex": "<string>",
                "type": "quantity",
                "prefix": "<string>",
                "suffix": "<string>",
                "priority": "Main",
                "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"
    }
  ]
}

Headers

x-publisher-token
string
required

The publisher token

Query Parameters

offerType
string

Type of offer.

recordLimit
number
default:100

Maximum number of items to return in the results.

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

Number of items to skip.

Required range: x >= 0
publisherOfferId
string

The unique identifier for the offer. Use this property to retrieve specific offers. To retrieve multiple offers, separate them with a ,.

Response

200
application/json

Offers successfully retrieved.

The response is of type object.