---
title: List widgets
slug: list-widgets
docTags: 
createdAt: 2026-05-04T13:13:49.254Z
---

{
  "id": "pWqsTHHNUmDszjhBoT3FY",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "/v1/widgets",
    "servers": [],
    "name": "List widgets",
    "description": "",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "websiteId",
          "type": "string",
          "description": "",
          "default": null,
          "pattern": "\\d+"
        },
        {
          "kind": "optional",
          "name": "offset",
          "type": "integer",
          "description": "Offset from which to start listing",
          "default": 0,
          "minimum": 0
        },
        {
          "kind": "required",
          "name": "limit",
          "type": "integer",
          "description": "<p>How many results to return (1-500)</p>",
          "default": 100,
          "minimum": 1,
          "maximum": 500
        },
        {
          "kind": "optional",
          "name": "active",
          "type": "string<Choice>",
          "description": "Filter by active status",
          "default": null,
          "format": "Choice",
          "enum": [
            "true",
            "false"
          ]
        },
        {
          "kind": "optional",
          "name": "type",
          "type": "string<Choice>",
          "description": "Filter by widget type",
          "default": null,
          "format": "Choice",
          "enum": [
            "popup",
            "callout",
            "bar",
            "embedded"
          ]
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "bearer",
          "name": "bearer",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Returned when successful",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "array",
            "description": "",
            "customType": "Widget[]",
            "schema": [
              {
                "name": "id",
                "kind": "optional",
                "type": "integer",
                "description": ""
              },
              {
                "name": "name",
                "kind": "required",
                "type": "string",
                "description": "",
                "minLength": 1,
                "maxLength": 255
              },
              {
                "name": "clicks",
                "kind": "optional",
                "type": "integer",
                "description": "",
                "default": 0
              },
              {
                "name": "views",
                "kind": "optional",
                "type": "integer",
                "description": "",
                "default": 0
              },
              {
                "name": "conversions",
                "kind": "optional",
                "type": "integer",
                "description": "",
                "default": 0
              },
              {
                "name": "goalsReached",
                "kind": "optional",
                "type": "integer",
                "description": "",
                "default": 0
              },
              {
                "name": "value",
                "kind": "optional",
                "type": "integer",
                "description": "",
                "default": 0
              },
              {
                "name": "extraValue",
                "kind": "optional",
                "type": "integer",
                "description": "",
                "default": 0
              },
              {
                "name": "submits",
                "kind": "optional",
                "type": "integer",
                "description": "",
                "default": 0
              },
              {
                "name": "completions",
                "kind": "optional",
                "type": "integer",
                "description": "",
                "default": 0
              },
              {
                "name": "contacts",
                "kind": "optional",
                "type": "integer",
                "description": "",
                "default": 0
              },
              {
                "name": "createDate",
                "kind": "optional",
                "type": "string<date-time>",
                "description": "",
                "format": "date-time"
              },
              {
                "name": "updateDate",
                "kind": "optional",
                "type": "string<date-time>",
                "description": "",
                "format": "date-time"
              },
              {
                "name": "active",
                "kind": "optional",
                "type": "boolean",
                "description": "",
                "default": false
              },
              {
                "name": "type",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "startDate",
                "kind": "optional",
                "type": "string<date-time>",
                "description": "",
                "format": "date-time"
              },
              {
                "name": "endDate",
                "kind": "optional",
                "type": "string<date-time>",
                "description": "",
                "format": "date-time"
              },
              {
                "name": "primaryGoalId",
                "kind": "optional",
                "type": "integer",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/Widget",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "s-Hdm9hkQ7UbHDqATO-0v",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url '/v1/widgets?websiteId=string&offset=integer&limit=100&active=true&type=popup' \\\n     --header 'accept: application/json'"
        },
        {
          "id": "xd1guEzCXoYBYdpKMc06Z",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"/v1/widgets?websiteId=string&offset=integer&limit=100&active=true&type=popup\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "6C_cjMkGgxYzvO3jkRkLZ",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/v1/widgets?websiteId=string&offset=integer&limit=100&active=true&type=popup\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "0ehC2k80Hnnq8O8K4OAKu",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"/v1/widgets?websiteId=string&offset=integer&limit=100&active=true&type=popup\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "s-Hdm9hkQ7UbHDqATO-0v"
    },
    "results": {
      "languages": [
        {
          "id": "vmlf8KQvYkZt7vWNC11JY",
          "language": "200",
          "code": "// Returned when successful\n[\n  {\n    \"id\": 0,\n    \"name\": \"\",\n    \"clicks\": 0,\n    \"views\": 0,\n    \"conversions\": 0,\n    \"goalsReached\": 0,\n    \"value\": 0,\n    \"extraValue\": 0,\n    \"submits\": 0,\n    \"completions\": 0,\n    \"contacts\": 0,\n    \"createDate\": \"\",\n    \"updateDate\": \"\",\n    \"active\": false,\n    \"type\": \"\",\n    \"startDate\": \"\",\n    \"endDate\": \"\",\n    \"primaryGoalId\": 0\n  }\n]"
        }
      ],
      "selectedLanguageId": "vmlf8KQvYkZt7vWNC11JY"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}