---
title: "Get Offer Designs"
method: GET
path: "/components/v1/offer-design"
tags: ["Offer Designs"]
---

# Get Offer Designs

`GET /components/v1/offer-design`

Retrieves a list of all offer designs.

## Headers

- `x-publisher-token` string, required

## Response `200`

Offer designs retrieved successfully.

- OfferDesignResponse[]
  - `id` string — Offer design ID.
  - `offerUiType` 'SpecialOffer' | 'Bundle' | 'PopUp' | 'RollingOffer' — Type of offer design.
  - `offerUiSubType` 'DailyBonus' | 'PostPurchase' | 'RewardCalendar' — Popup design subtype. Only relevant when `offerUiType` is `PopUp`.
  - `name` string — Offer design name.
  - `externalId` string — Offer design ID that you defined.
  - `backgroundImageUrl` string, url — Background image URL for the offer design.
  - `externalBackgroundImageUrl` string, url — Original background image URL when the design uses an external image URL.
  - `backgroundExternalImageUrl` string, url — Original background image URL when an external image URL is used. Only relevant for Rolling Offers.
  - `title` OfferTitle
    - `text` string — Offer title.
    - `fontColor` object — Title font color. **Note:** For Daily Bonuses and Triggered Popups, this property is returned as a string. For Special Offers, this property is returned as an object as shown below.
      - `colorOne` string — Primary title font color. Only relevant for Special Offers.
      - `colorTwo` string — Secondary title font color. Only relevant for Special Offers.
      - `direction` string — Color transition direction. Only relevant for Special Offers.
    - `fontSize` number — Font size in pixels.
    - `fontWeight` string — Font weight.
  - `buttonSuffixImage` string — Button asset suffix. Only relevant for Bundles and Special Offers.
  - `buttonSuffixAnimation` string — Button asset suffix animation. Only relevant for Bundles and Special Offers.
  - `backgroundColor` object — Background color. **Note:** For Rolling Offers, this property is returned as a string. For Bundles, this property is returned as an object as shown below.
    - `colorOne` string — Primary color.
    - `colorTwo` string — Secondary color.
    - `gradientDirection` 'to top' | 'to bottom' | 'to left' | 'to right' | 'to top left' | 'to top right' | 'to bottom left' | 'to bottom right' — Gradient direction.
  - `backgroundOpacity` number — Background opacity value. Only relevant for Rolling Offers.
  - `headerImage` string, url — Header image URL. Only relevant for Rolling Offers.
  - `arrowColor` string — Arrow color. Only relevant for Rolling Offers.
  - `borderColor` ColorDetails — Color details returned by offer designs.
    - `colorOne` string — Primary color.
    - `colorTwo` string — Secondary color.
    - `direction` string — Direction of the color transition.
  - `borderWidth` number — Border width in pixels. Only relevant for Rolling Offers.
  - `subRollingOffer` SubRollingOfferResponse
    - `backgroundImageUrl` string, url — Background image URL for the sub rolling offer.
    - `backgroundExternalImageUrl` string, url — Original background image URL for the sub rolling offer when an external image URL is used.
    - `collectText` string — Text displayed for the collect action.
  - `rewardCalendar` RewardCalendarDesignBlockResponse — Information about the reward calendar design.
    - `collectibleBadgeImage` string, url — Badge image to display when a reward is able to be collected.
    - `lockedBadgeImage` string, url — Badge image to display when a reward is locked.
    - `backgroundColor` string — Reward calendar background color in hex format.
    - `collectIconImage` string, url — Icon image displayed when a reward has been collected.
    - `lockedIconImage` string, url — Icon image displayed when a reward is locked.
    - `dayFontColor` string — Day label font color in hex format.
    - `subRewardBackgroundImage` string, url — Sub reward background image URL.
    - `mainRewardBackgroundImage` string, url — Main reward background image URL.
    - `headerImage` string, url — Header image URL.

---

[API](https://skmtc.net/appcharge/apis/grant-award.md) · [All operations](https://skmtc.net/appcharge/apis/grant-award/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/appcharge/grant-award/revisions/b4f6759240d5/schema)