List widget types

Overview

List all active widget types for the widget builder. Also returns the widget add-on status when you supply store_id (whether the store has an active add-on and which store ids it covers).

Prerequisites

• A bearer token in the Authorization header.

Base URL

Endpoint

GET /api/v1/widget/type

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Bearer — any valid token (no role or ownership gate is applied).

Rate limit

• No rate limit.

Query parameters

How it works

• 200 with { "data": { "status": "success", "data": [.widget types ], "widget_add_ons": { status, store_ids } | null } }. widget_add_ons is null when no store_id is given.

Response

200 OK · 200

{
  "data": {
    "status": "success",
    "data": [
      {
        "id": 1,
        "name": "Feed Widget",
        "status": "active"
      },
      {
        "id": 2,
        "name": "Badge Widget",
        "status": "active"
      }
    ],
    "widget_add_ons": {
      "status": true,
      "store_ids": [
        26,
        27
      ]
    }
  }
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/widget/type?store_id=123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'