The Component Object

An object that represents a component in a space. You can define any component properties that are not read-only.

Tip

If is_nestable and is_root properties are set to false, the component is nestable.

Properties

• id number

  Numeric ID of a component

• name string

  Technical name of a component. Visible in the content editor if the display_name is null.

• display_name string

  Name displayed in the content editor

• created_at string

  Creation date (format: yyyy-MM-dd'T'HH:mm:ssZ)

• updated_at string

  Latest update date (format: yyyy-MM-dd'T'HH:mm:ssZ)

• schema object

  Key value pairs of the component fields

• image string | null

  URL of the component preview image (if uploaded)

• preview_field string

  The component preview field in the UI

• is_root boolean

  true if a component can be used as a content type block

• preview_tmpl string

  The component preview template. Learn how to create a preview template.

• is_nestable boolean

  true if a component is a Nestable block

• all_presets object[]

  An array of presets for a component. Learn more about presets.

  Show child properties

  • id number

    Numeric ID of a preset

  • name string

    Name of a preset

  • component_id number

    Numeric ID of a component associated with the preset

  • image string | null

    Link to a preview image of the preset

  • icon string

    Icon of the preset

  • color string

    Color of the icon

  • description string

    The description of the preset

• real_name string

  A read-only field used by Storyblok internally. Identical to the display_name if set. Otherwise, it’s set to the name.

• component_group_uuid string

  The component folder ID

• icon string

  Icon of the component

• color string

  Color of the icon

• internal_tags_list object[]

  List of objects containing the internal tags assigned to a component. Learn more about internal tags.

  Show child properties

  • id number

    Numeric ID of a tag

  • name string

    Name of a tag

• internal_tag_ids string[]

  List of IDs of the internal tags assigned to a component

• content_type_asset_preview string

  Asset preview field of a content type block

Example Object

{
"component": {
  "name": "banner_section",
  "display_name": null,
  "created_at": "2025-03-27T10:35:25.086Z",
  "updated_at": "2025-07-04T08:30:54.235Z",
  "id": 3672886,
  "schema": {
    "headline": {
      "type": "text",
      "pos": 0,
      "translatable": true,
      "description": "This field is used to render a title"
    }
  },
  "image": "//a.storyblok.com/f/88751/x/d4284bb2e5/screenshot.png",
  "preview_field": null,
  "is_root": false,
  "preview_tmpl": null,
  "is_nestable": true,
  "all_presets": [],
  "preset_id": null,
  "real_name": "banner_section",
  "component_group_uuid": "19cb297f-541a-4a23-b02e-66d08e5f6323",
  "color": "#fbce41",
  "icon": "block-icon",
  "internal_tags_list": [
    {
      "id": 43211,
      "name": "test"
    },
    {
      "id": 43212,
      "name": "test2"
    }
  ],
  "internal_tag_ids": [
    "43211",
    "43212"
  ],
  "content_type_asset_preview": "hero_image"
  }
}