Widgets

Fetch widgets from API

get/api/v2/widgets

Request

  • Base URL: https://api.ratingcaptain.com
  • URL: https://api.ratingcaptain.com/api/v2/widgets
  • Auth: API key in header api-token

Headers

api-tokenstring
website-tokenstring

Request body

pagenumber nullable

Must be at least 1.

per_pagenumber nullable

Must be at least 1. Must not be greater than 100.

fromstring nullable

Must be a valid date. Must be a valid date in the format <code>Y-m-d</code>.

tostring nullable

Must be a valid date. Must be a valid date in the format <code>Y-m-d</code>.

Example request

{
  "page": 30,
  "per_page": 10,
  "from": "2026-10-13",
  "to": "2026-10-13"
}

Response

Example response

{
  "data": [
    {
      "id": 100839,
      "website_id": 8,
      "layout_id": 1,
      "style_id": 1,
      "font_family": null,
      "font_color": null,
      "data": {
        "data": {
          "layout_details": {
            "full_width": "1"
          }
        },
        "colors": {
          "font": "Inter",
          "mode": "light",
          "star": "#FECD2F",
          "stars": "#FECD2F",
          "accent": "#4D55F8"
        },
        "header": {
          "active": true,
          "average": true,
          "sortable": true,
          "filterable": true,
          "show_title": true,
          "title_text": "Example title",
          "border_color": "#E7EBF8",
          "border_width": "0",
          "starsOptions": {
            "bold": false,
            "align": "center",
            "color": "#8991AE",
            "italic": false,
            "font_size": "14",
            "underline": false
          },
          "titleOptions": {
            "bold": true,
            "align": "center",
            "color": "#303445",
            "italic": false,
            "font_size": "28",
            "underline": false
          },
          "border_radius": "10",
          "reviews_count": true,
          "show_subtitle": true,
          "subtitle_text": "Read reviews",
          "averageOptions": {
            "bold": false,
            "align": "left",
            "color": "#303445",
            "italic": false,
            "font_size": "14",
            "underline": false
          },
          "average_layout": "horizontal",
          "can_add_review": true,
          "display_average": true,
          "filter_by_stars": true,
          "subtitleOptions": {
            "bold": false,
            "align": "center",
            "color": "#8991AE",
            "italic": false,
            "font_size": "18",
            "underline": false
          },
          "background_color": "#FFFFFF",
          "average_font_size": 20,
          "add_review_button_text": "Write review"
        },
        "style_id": "1",
        "layout_id": "1",
        "card_styles": {
          "show_date": true,
          "show_photo": true,
          "show_stars": true,
          "show_source": true,
          "border_color": "#E7EBF8",
          "border_width": "1",
          "content_type": "full",
          "show_content": true,
          "authorOptions": {
            "bold": true,
            "align": "left",
            "color": "#303445",
            "italic": false,
            "font_size": "14",
            "underline": false
          },
          "border_radius": "10",
          "contentOptions": {
            "bold": false,
            "align": "left",
            "color": "#454B63",
            "italic": false,
            "font_size": "14",
            "underline": false
          },
          "background_color": "#FFFFFF",
          "show_author_name": true,
          "user_card_version": "standard",
          "show_author_avatar": false,
          "show_verified_badge": true
        },
        "date_format": "D/M/Y",
        "rc_branding": true,
        "schema_active": 1,
        "layout_details": {
          "full_width": true,
          "autorotation": true,
          "columns_count": 3,
          "columns_space": "32",
          "display_arrows": true,
          "autorotation_time": 5000,
          "background_color": "#FFFFFF",
          "border_width": 1,
          "border_color": "#DBE0F1"
        },
        "omnibus_setting": {
          "active": 0,
          "link_setting": {
            "active": false,
            "url": null
          }
        }
      },
      "active": true,
      "type": "v3",
      "name": "Profile widget test",
      "excluded_platforms": null,
      "created_at": "2023-05-19T10:57:50.000000Z",
      "updated_at": "2023-05-19T11:40:53.000000Z",
      "additional_css": null,
      "chained_before_id": null,
      "chained_after_id": null,
      "placements": null,
      "omnibus_setting": {
        "active": 0,
        "link_setting": {
          "url": null,
          "active": false
        }
      },
      "source": 1,
      "widget_id": null,
      "display_count": 0,
      "iframe_link": "https://api.ratingcaptain.com/widget_v3/render/100839",
      "layout": {
        "name": {
          "en": "Carousel",
          "pl": "Karuzela",
          "de": "Carousel",
          "it": "Carousel",
          "es": "Carousel",
          "cz": "Carousel",
          "hu": "Carousel",
          "fr": "Carousel",
          "de-ch": "Carousel",
          "ro": "Carousel",
          "uk": "Carousel"
        },
        "icon": "default/widgets_v3/layouts/carousel.svg",
        "uuid": "1",
        "order": 1,
        "component": "default",
        "vueDetailsComponent": "widget-carousel-editor",
        "validator": {},
        "perPageService": "Modules\\Widget\\Services\\PerPageCalculations\\Carousel",
        "t_name": "Carousel"
      },
      "style": {
        "name": {
          "en": "Standard",
          "pl": "Standardowa",
          "de": "Standard",
          "it": "Standard",
          "es": "Standard",
          "cz": "Standard",
          "hu": "Standard",
          "fr": "Standard",
          "de-ch": "Standard",
          "ro": "Standard",
          "uk": "Standard"
        },
        "uuid": 1,
        "image_preview": "default/widgets_v3/styles/standard.png",
        "t_name": "Standard"
      },
      "integration_code": "<div data-widget=\"100839\"  ></div>\n                <script src=\"https://api.ratingcaptain.com/widget_v3/js/e95d37bba10a08e47c39780da30be8de\"></script>"
    }
  ],
  "links": {
    "first": "https://api.ratingcaptain.com/api/v2/widgets?page=1",
    "last": "https://api.ratingcaptain.com/api/v2/widgets?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://api.ratingcaptain.com/api/v2/widgets?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "https://api.ratingcaptain.com/api/v2/widgets",
    "per_page": 30,
    "to": 10,
    "total": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.