Offers API

curl --get "https://tyviso.com/dev/gap/api" \
  -d "preview=false" \
  -d "flow=category" \
  --header "X-API-Key: $KEY" \
  --header "Accept: application/json"

const url = new URL("https://tyviso.com/dev/gap/api");
url.search = new URLSearchParams({ preview: "false", flow: "category" });
const res = await fetch(url, { headers: { "X-API-Key": KEY } });
const feed = await res.json();

{
  "headerTemplate": 2,
  "settings": {
    "ctaLabel": "Claim now",
    "ctaColor": "#FFFFFF",
    "ctaBg": "#4AAEAB",
    "headerBg": "#FFFFFF",
    "headerTextColor": "#000000",
    "sectionTitles": [],
    "socialProof": {
      "enabled": false,
      "socialCta": { "62de5497af4834865468d308": "0 Claimed" },
      "stickers": {},
      "dynamicSocials": false,
      "position": "on_image",
      "displayMode": "exact",
      "showValue": 0,
      "fallbackText": "New"
    }
  },
  "lastcached": 1785844280818,
  "hero": [],
  "popular": [],
  "all": [
    {
      "id": "62de5497af4834865468d308",
      "partner": "Jimmy's Iced Coffee",
      "partnerLogo": "https://…/logo-400x200.png",
      "category": { "name": "Property", "parent": "Finance & Insurance" },
      "ageRestricted": false,
      "terms": "https://…",
      "url": "https://…",
      "title": "Get 25% Off Your First Order @ Jimmy's Iced Coffee",
      "description": "At Jimmy's we know how to make Iced Coffee. Get 25% Off Original, Mocha, Oat & Extra Shot Iced Coffee with free UK delivery.",
      "image": "https://…/image.jpg",
      "offerInfoButtonDiscount": "25% Off",
      "offerInfoButtonDescription": "Refreshing Iced Coffee Delivery Service. Recyclable packaging & free next day delivery. 25% Off code TY-COFFEE25 applied automatically at checkout",
      "offerInfoButtonCta": "LimitedTimeOffer",
      "offerDiscountCode": "TY-COFFEE25",
      "offerDiscountCodeType": "availableAtCheckout",
      "hasMultipleCodes": false,
      "cta": "Claim now",
      "expiry": null
    }
  ],
  "testOffers": []
}

← Back to API Integration Requires an API key — see Authentication. GET https://tyviso.com/gap/api?preview=[true/false]&flow=[category] Returns the full payload used to render your hosted Rewards page or widget: the header template, CTA styling, social-proof configuration, and the live offers for each placement (hero, popular, all).

This is a separate path from the tracking API — it’s not a tracking request.

Discrepancy in the source material: the endpoint is documented at tyviso.com/gap/api, but the reference example below calls tyviso.com/dev/gap/api. We haven’t been able to confirm which is correct — check with your Tyviso Technical Lead before relying on either in production, and use whichever URL your account manager confirms.

Parameters

string

Category of offers to return.

string

true or false — preview unpublished offers before they go live.

curl --get "https://tyviso.com/dev/gap/api" \
  -d "preview=false" \
  -d "flow=category" \
  --header "X-API-Key: $KEY" \
  --header "Accept: application/json"

const url = new URL("https://tyviso.com/dev/gap/api");
url.search = new URLSearchParams({ preview: "false", flow: "category" });
const res = await fetch(url, { headers: { "X-API-Key": KEY } });
const feed = await res.json();

{
  "headerTemplate": 2,
  "settings": {
    "ctaLabel": "Claim now",
    "ctaColor": "#FFFFFF",
    "ctaBg": "#4AAEAB",
    "headerBg": "#FFFFFF",
    "headerTextColor": "#000000",
    "sectionTitles": [],
    "socialProof": {
      "enabled": false,
      "socialCta": { "62de5497af4834865468d308": "0 Claimed" },
      "stickers": {},
      "dynamicSocials": false,
      "position": "on_image",
      "displayMode": "exact",
      "showValue": 0,
      "fallbackText": "New"
    }
  },
  "lastcached": 1785844280818,
  "hero": [],
  "popular": [],
  "all": [
    {
      "id": "62de5497af4834865468d308",
      "partner": "Jimmy's Iced Coffee",
      "partnerLogo": "https://…/logo-400x200.png",
      "category": { "name": "Property", "parent": "Finance & Insurance" },
      "ageRestricted": false,
      "terms": "https://…",
      "url": "https://…",
      "title": "Get 25% Off Your First Order @ Jimmy's Iced Coffee",
      "description": "At Jimmy's we know how to make Iced Coffee. Get 25% Off Original, Mocha, Oat & Extra Shot Iced Coffee with free UK delivery.",
      "image": "https://…/image.jpg",
      "offerInfoButtonDiscount": "25% Off",
      "offerInfoButtonDescription": "Refreshing Iced Coffee Delivery Service. Recyclable packaging & free next day delivery. 25% Off code TY-COFFEE25 applied automatically at checkout",
      "offerInfoButtonCta": "LimitedTimeOffer",
      "offerDiscountCode": "TY-COFFEE25",
      "offerDiscountCodeType": "availableAtCheckout",
      "hasMultipleCodes": false,
      "cta": "Claim now",
      "expiry": null
    }
  ],
  "testOffers": []
}

Show Response fields

integer

Numeric ID of the header layout your widget is using.

object

CTA copy/colours, header styling, and socialProof display rules — render these directly, don’t hardcode your own.

object[]

Arrays of Offer objects for each placement. all is your full catalogue; hero / popular may be empty if unset for your account.

integer

Commission share and the epoch ms this feed was last cached.

See Errors for error shapes.

Last modified on August 26, 2026

curl --get "https://tyviso.com/dev/gap/api" \
  -d "preview=false" \
  -d "flow=category" \
  --header "X-API-Key: $KEY" \
  --header "Accept: application/json"

const url = new URL("https://tyviso.com/dev/gap/api");
url.search = new URLSearchParams({ preview: "false", flow: "category" });
const res = await fetch(url, { headers: { "X-API-Key": KEY } });
const feed = await res.json();

{
  "headerTemplate": 2,
  "settings": {
    "ctaLabel": "Claim now",
    "ctaColor": "#FFFFFF",
    "ctaBg": "#4AAEAB",
    "headerBg": "#FFFFFF",
    "headerTextColor": "#000000",
    "sectionTitles": [],
    "socialProof": {
      "enabled": false,
      "socialCta": { "62de5497af4834865468d308": "0 Claimed" },
      "stickers": {},
      "dynamicSocials": false,
      "position": "on_image",
      "displayMode": "exact",
      "showValue": 0,
      "fallbackText": "New"
    }
  },
  "lastcached": 1785844280818,
  "hero": [],
  "popular": [],
  "all": [
    {
      "id": "62de5497af4834865468d308",
      "partner": "Jimmy's Iced Coffee",
      "partnerLogo": "https://…/logo-400x200.png",
      "category": { "name": "Property", "parent": "Finance & Insurance" },
      "ageRestricted": false,
      "terms": "https://…",
      "url": "https://…",
      "title": "Get 25% Off Your First Order @ Jimmy's Iced Coffee",
      "description": "At Jimmy's we know how to make Iced Coffee. Get 25% Off Original, Mocha, Oat & Extra Shot Iced Coffee with free UK delivery.",
      "image": "https://…/image.jpg",
      "offerInfoButtonDiscount": "25% Off",
      "offerInfoButtonDescription": "Refreshing Iced Coffee Delivery Service. Recyclable packaging & free next day delivery. 25% Off code TY-COFFEE25 applied automatically at checkout",
      "offerInfoButtonCta": "LimitedTimeOffer",
      "offerDiscountCode": "TY-COFFEE25",
      "offerDiscountCodeType": "availableAtCheckout",
      "hasMultipleCodes": false,
      "cta": "Claim now",
      "expiry": null
    }
  ],
  "testOffers": []
}

Integration Documentation

Getting Started

Platform

Integration

Features

Get widget offers feed

​Get widget offers feed

Get widget offers feed