Skip to main content
GET
/
components
/
v1
/
offer-design
cURL
curl --request GET \
  --url https://api-sandbox.appcharge.com/components/v1/offer-design \
  --header 'x-publisher-token: <api-key>'
[
  {
    "id": "507f1f77bcf86cd799439011",
    "offerUiType": "SpecialOffer",
    "name": "Summer Special",
    "externalId": "summer_special_offer",
    "backgroundImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439011_background.png",
    "externalBackgroundImageUrl": "https://example.com/images/summer-special.png",
    "title": {
      "text": "Limited Time Offer",
      "fontColor": "#FFFFFF",
      "fontSize": 16,
      "fontWeight": "bold"
    }
  },
  {
    "id": "507f1f77bcf86cd799439012",
    "offerUiType": "Bundle",
    "name": "Starter Pack",
    "externalId": "starter_pack_design",
    "backgroundImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439012_background.png",
    "externalBackgroundImageUrl": "https://example.com/images/starter-pack.png",
    "backgroundColor": {
      "colorOne": "#FF5F6D",
      "colorTwo": "#FFC371",
      "gradientDirection": "to right"
    }
  },
  {
    "id": "507f1f77bcf86cd799439013",
    "offerUiType": "PopUp",
    "name": "Daily Reward",
    "externalId": "daily_reward_popup",
    "backgroundImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439013_background.png",
    "externalBackgroundImageUrl": "https://example.com/images/daily-reward-popup.png",
    "title": {
      "text": "Your Reward Awaits",
      "fontColor": "#000000",
      "fontSize": 14,
      "fontWeight": "regular"
    }
  },
  {
    "id": "507f1f77bcf86cd799439014",
    "offerUiType": "RollingOffer",
    "name": "Daily Deals",
    "externalId": "daily_rolling_offer",
    "backgroundImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439014_background.png",
    "backgroundColor": "#1A237E",
    "backgroundOpacity": 80,
    "headerImage": "https://example.com/images/rolling-offer-header.png",
    "arrowColor": "#FFB74D",
    "borderColor": {
      "colorOne": "#FF5F6D",
      "colorTwo": "#FFC371",
      "gradientDirection": "to bottom"
    },
    "borderWidth": 2,
    "subRollingOffer": {
      "backgroundImageUrl": "https://cdn.appcharge.com/sub_offer_bg_image.png",
      "collectText": "Collect Now"
    }
  }
]

[
  {
    "id": "507f1f77bcf86cd799439011",
    "offerUiType": "SpecialOffer",
    "name": "Summer Special",
    "externalId": "summer_special_offer",
    "backgroundImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439011_background.png",
    "externalBackgroundImageUrl": "https://example.com/images/summer-special.png",
    "title": {
      "text": "Limited Time Offer",
      "fontColor": "#FFFFFF",
      "fontSize": 16,
      "fontWeight": "bold"
    }
  },
  {
    "id": "507f1f77bcf86cd799439012",
    "offerUiType": "Bundle",
    "name": "Starter Pack",
    "externalId": "starter_pack_design",
    "backgroundImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439012_background.png",
    "externalBackgroundImageUrl": "https://example.com/images/starter-pack.png",
    "backgroundColor": {
      "colorOne": "#FF5F6D",
      "colorTwo": "#FFC371",
      "gradientDirection": "to right"
    }
  },
  {
    "id": "507f1f77bcf86cd799439013",
    "offerUiType": "PopUp",
    "name": "Daily Reward",
    "externalId": "daily_reward_popup",
    "backgroundImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439013_background.png",
    "externalBackgroundImageUrl": "https://example.com/images/daily-reward-popup.png",
    "title": {
      "text": "Your Reward Awaits",
      "fontColor": "#000000",
      "fontSize": 14,
      "fontWeight": "regular"
    }
  },
  {
    "id": "507f1f77bcf86cd799439014",
    "offerUiType": "RollingOffer",
    "name": "Daily Deals",
    "externalId": "daily_rolling_offer",
    "backgroundImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439014_background.png",
    "backgroundColor": "#1A237E",
    "backgroundOpacity": 80,
    "headerImage": "https://example.com/images/rolling-offer-header.png",
    "arrowColor": "#FFB74D",
    "borderColor": {
      "colorOne": "#FF5F6D",
      "colorTwo": "#FFC371",
      "gradientDirection": "to bottom"
    },
    "borderWidth": 2,
    "subRollingOffer": {
      "backgroundImageUrl": "https://cdn.appcharge.com/sub_offer_bg_image.png",
      "collectText": "Collect Now"
    }
  }
]

Authorizations

​
x-publisher-token
string
header
required

Publisher token, as displayed in the Publisher Dashboard.

Response

200 - application/json

Offer designs retrieved successfully.

​
getAllOfferDesignsResponse
object[]