GET
/
site
{
  "name": "<string>",
  "url": "https://supertab.co",
  "auth_redirect_uri": "https://signon.supertab.co/auth-proxy",
  "logo_url": "<string>",
  "content_keys": [
    "<string>"
  ],
  "offerings": [
    {
      "id": "offering.cf637646-71a4-430d-aaea-a66f1a48a83c",
      "description": "1 week access to theleek.com",
      "entitlement_details": {
        "content_key": "site.cf637646-71a4-430d-aaea-a66f1a48a83c",
        "duration": "1w",
        "is_recurring": false
      },
      "price": {
        "amount": 50,
        "currency": {
          "code": "USD",
          "name": "US Dollar",
          "symbol": "$",
          "base_unit": 100
        }
      },
      "is_pay_now": true
    }
  ],
  "experiences": [
    {
      "id": "experience.cf637646-71a4-430d-aaea-a66f1a48a83c",
      "name": "<string>",
      "type": "basic_paygate",
      "offerings": [
        "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
      ],
      "configuration": {
        "ui_config": {},
        "on_close": "<string>",
        "upsells": [
          {
            "main_offering": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
            "upsell_offering": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
            "discount": 123
          }
        ]
      }
    }
  ],
  "test_mode": true
}

Required Scopes

capi:read - Read access to Customer API resources

Headers

​
x-api-version
string
default:2025-04-01

The version of the Customer API you are using.

​
x-supertab-client-id
string
required

Your Client ID with Supertab. Used to identify the website on which Customer is making a Purchase.

Examples:

"live_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"

"test_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"

Response

200
application/json
Successful Response

A site is any website, SaaS product or any other place you deploy Supertab.

It is the top level object in your inventory and contains all offerings.