Widgets

Widget data and schema retrieval

Retrieve widget data

get

Returns widget template context data including attributes, name, slug, and template.

Path parameters

slugstringRequired

Widget slug identifier

Responses

200

Widget data retrieved

application/json

Widget template context data returned by the widget endpoint. Contains widget name, slug, template path, and attributes. The attributes structure depends on the widget type schema. Used for rendering widgets in pages and templates.

namestringRequiredExample: Featured Products

slugstringRequiredExample: featured-products

templatestringRequiredExample: widgets/featured_products.html

404

Widget not found

get

/widgets/{slug}/

HTTPcURLJavaScriptPython

GET /widgets/{slug}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "name": "Featured Products",
  "slug": "featured-products",
  "template": "widgets/featured_products.html",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Retrieve widget schema

get

Returns the widget type schema for the specified widget slug.

Path parameters

slugstringRequired

Widget slug identifier

Responses

200

Widget schema retrieved

application/json

Defines a widget type with its JSON schema for validating and configuring widget attributes. Used to retrieve widget type information and understand what attributes a widget supports. The schema defines the structure and validation rules for widget attributes.

pkintegerRequiredExample: 1

namestringRequiredExample: Product Carousel

404

Widget not found or has no widget type

get

/widgets/{slug}/schema/

HTTPcURLJavaScriptPython

GET /widgets/{slug}/schema/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "pk": 1,
  "name": "Product Carousel",
  "schema": {
    "title": {
      "type": "string",
      "required": true
    },
    "limit": {
      "type": "integer",
      "default": 10
    }
  }
}