Widgets


GET/widgets/{uuid}

Get widget data

Get widget reviews and config by its UUID

Path Parameters
  • Name
    uuid
    Type
    string
    Required
    required
    Description
    The UUID of the widget
Responses

Request

GET
/widgets/{uuid}
const uuid = `c0570680-914a-4149-96e4-2d717a442928`;
const url = `https://featurable.com/api/v2/widgets/${uuid}`;
const xApiKey = process.env.FEATURABLE_API_KEY;
const options = {
  method: "GET",
  headers: {
    accept: "application/json",
    "X-API-Key": xApiKey,
  },
  credentials: "include",
};

fetch(url, options)
  .then((res) => res.json())
  .then((json) => console.log(json))
  .catch((err) => console.error(err));

Response

{
    "success": true,
    "widget": {
        "uuid": "c0570680-914a-4149-96e4-2d717a442928",
        "config": {
            "layout": "carousel_default",
            "language": "en",
            "name": null,
            "color_scheme": "light",
            "name_display": "firstAndLastInitials",
            "title": "What our customers are saying",
            "show_title": true,
            "carousel_autoplay": true,
            "carousel_speed": 5000,
            "max_characters": 255,
            "date_display": "relative",
            "schema": true,
            "schema_type": null,
            "schema_sub_type": null,
            "schema_sub_sub_type": null,
            "summary": true,
            "summary_review_button": true,
            "show_profile_pictures": true,
            "custom_css": "",
            "allowed_domains": []
        },
        "reviews": [
            {
                "id": "1",
                "platform": "gbp",
                "author": {
                    "name": "Isabella Li",
                    "avatarUrl": null,
                    "profileUrl": null
                },
                "title": null,
                "text": "[EXAMPLE REVIEW] I was hesitant to invest in this product at first, but I'm so glad I did. It has been a total game-changer for me.",
                "originalText": null,
                "languageCode": "en",
                "rating": {
                    "value": 5,
                    "max": 5
                },
                "publishedAt": "2025-11-22T21:15:38.147Z",
                "createdAt": "2025-11-22T21:15:38.148Z",
                "updatedAt": "2025-11-22T21:15:38.148Z",
                "lastSyncedAt": null,
                "metadata": {},
                "url": null
            },
            {
                "id": "2",
                "platform": "gbp",
                "author": {
                    "name": "Sophia Moore",
                    "avatarUrl": null,
                    "profileUrl": null
                },
                "title": null,
                "text": "[EXAMPLE REVIEW] I've tried similar products in the past, but none of them compare to this one. It's in a league of its own in terms of functionality, durability, and overall value. I can't recommend it highly enough!",
                "originalText": null,
                "languageCode": "en",
                "rating": {
                    "value": 5,
                    "max": 5
                },
                "publishedAt": "2025-11-22T21:15:38.148Z",
                "createdAt": "2025-11-22T21:15:38.148Z",
                "updatedAt": "2025-11-22T21:15:38.148Z",
                "lastSyncedAt": null,
                "metadata": {},
                "url": null
            }
        ],
        "isExampleReviews": true,
        "gbpLocationUuid": "c4560680-914a-4149-96e4-2d717a442928",
        "gbpLocationSummary": {
            "reviewsCount": 123,
            "rating": 4.9,
            "writeAReviewUri": "https://featurable.com"
        },
        "showBranding": true
    }
}
OK

Was this page helpful?