Skip to main content
GET
/
widget-studio
Get all studios
curl --request GET \
  --url https://api.kameleoon.com/widget-studio \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.kameleoon.com/widget-studio"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kameleoon.com/widget-studio', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kameleoon.com/widget-studio",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.kameleoon.com/widget-studio"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.kameleoon.com/widget-studio")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/widget-studio")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z",
    "elements": [],
    "eventActions": [],
    "eventConditions": [],
    "fonts": [
      {
        "fontFamily": "<string>",
        "fontSrc": "<string>",
        "fontWeights": [
          "<string>"
        ],
        "id": "<string>",
        "importSrc": "<string>"
      }
    ],
    "isLegacy": true,
    "screens": [
      {
        "id": "<string>",
        "name": "<string>",
        "templateName": "<string>"
      }
    ],
    "translation": {
      "defaultLanguageId": "<string>",
      "enabled": true,
      "languages": [
        {
          "IID": "<string>",
          "code": "<string>",
          "name": "<string>"
        }
      ]
    },
    "version": 123,
    "widgetEditorTemplate": "<string>",
    "widgetId": 123
  }
]
{
"code": "<string>",
"impersonator": "<string>",
"message": "<string>",
"name": "<string>",
"sub": "<string>",
"time": 123,
"timestamp": "2023-11-07T05:31:56Z"
}
{
"code": "<string>",
"impersonator": "<string>",
"message": "<string>",
"name": "<string>",
"sub": "<string>",
"time": 123,
"timestamp": "2023-11-07T05:31:56Z"
}
{
"code": "<string>",
"impersonator": "<string>",
"message": "<string>",
"name": "<string>",
"sub": "<string>",
"time": 123,
"timestamp": "2023-11-07T05:31:56Z"
}
{
"code": "<string>",
"impersonator": "<string>",
"message": "<string>",
"name": "<string>",
"sub": "<string>",
"time": 123,
"timestamp": "2023-11-07T05:31:56Z"
}
{
"code": "<string>",
"impersonator": "<string>",
"message": "<string>",
"name": "<string>",
"sub": "<string>",
"time": 123,
"timestamp": "2023-11-07T05:31:56Z"
}
{
"code": "<string>",
"impersonator": "<string>",
"message": "<string>",
"name": "<string>",
"sub": "<string>",
"time": 123,
"timestamp": "2023-11-07T05:31:56Z"
}
{
"code": "<string>",
"impersonator": "<string>",
"message": "<string>",
"name": "<string>",
"sub": "<string>",
"time": 123,
"timestamp": "2023-11-07T05:31:56Z"
}
{
"code": "<string>",
"impersonator": "<string>",
"message": "<string>",
"name": "<string>",
"sub": "<string>",
"time": 123,
"timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

paramsIO
Request params · object
required
optionalFields
string[]

Response

OK

dateCreated
string<date-time>
read-only

Date the widget studio object was created.

dateModified
string<date-time>
read-only

Date the widget studio object was last modified.

elements
enum<string>[]

List of element types used in the widget studio.

Available options:
BOX,
BUTTON,
BUTTON_V2,
CHECKBOX,
CLOSE,
COPY,
COUNTDOWN,
COUNTDOWN_V2,
COUNTDOWN_PROGRESS_BAR,
COUNTDOWN_V2_PROGRESS_BAR,
DATE,
FORM_ERROR_MESSAGE,
GROUP,
HEADING,
HIDDEN_INPUT,
HTML,
IFRAME,
IMAGE,
INPUT,
LINK,
SCROLLING_TEXT,
MULTI_STEP_FORM,
PRODUCT_RECO,
PROGRESS_BAR,
RADIO_BUTTON,
SELECT,
SHAPE,
SLIDER,
STEP_PROGRESS_BAR,
TEXT,
TEXTAREA,
TIME,
TOOLTIP,
TOGGLE,
VIDEO,
QR_CODE,
RANGE_INPUT,
SPIN_WHEEL,
SCALE,
SCRATCH_CARD,
NPS,
MULTI_CHOICE,
SHORT_TEXT,
LONG_TEXT
eventActions
enum<string>[]

List of event actions that can be triggered within the widget studio.

Available options:
SET_LOCAL_STORAGE,
SET_SESSION_STORAGE,
SET_COOKIES,
SHOW_ELEMENT,
HIDE_ELEMENT,
SET_STEP,
CLICK_ON_ELEMENT,
FORM_DISABLE,
FORM_ENABLE,
JAVASCRIPT,
PROCESS_CONVERSION,
CANCEL_CONVERSION,
SET_CUSTOM_DATA,
TRIGGER_EVENT,
SET_PROGRESS,
SEND_DATA,
RUN_ROTATION_SPIN_WHEEL,
SET_LOCALE,
URL_REDIRECT
eventConditions
enum<string>[]

List of event conditions that determine widget studio behavior.

Available options:
BEFORE_DISPLAY,
AFTER_DISPLAY,
ON_COUNTDOWN_END,
IS_MOBILE,
IS_NOT_MOBILE,
IS_TABLET,
IS_NOT_TABLET,
IS_DESKTOP,
IS_NOT_DESKTOP,
FORM_ITEM_VALUE,
BY_CUSTOM_DATA,
ON_CLICK,
ON_SUCCESS,
ON_ERROR,
REVEALED_SCRATCH_CARD,
ON_SPIN_WHEEL_TURNED,
WIN_SLICE_VALUE,
ON_TIMER_END,
VISITOR_BROWSER_LANGUAGE,
URL_CONTAINS,
URL_REGEX,
ON_VIDEO_END
fonts
Widget font (variant 1) · object[]

List of custom fonts used within the widget studio.

isLegacy
boolean

Indicate if the widget is part of a legacy system

screens
Screen · object[]

List of screens that are part of this widget studio configuration.

translation
Translation · object

Translation settings for the widget studio.

version
number<double>

Version of the widget, precision = 5, scale = 2.

widgetEditorTemplate
string

Serialized JSON representation of the widget configuration used in the editor.

widgetId
integer<int64>
read-only

Id of the widget.