The Story Object

This is an object representing your content entry. One story object can be of different types, called content types, and is able to contain components along with the content. You define the fields and nestability of your content types to achieve your content structure.

You can use this object to build up your entities when migrating or importing content.

Properties

id number

Numeric id of the story
name string

The complete name provided for the story
parent_id number

ID of the parent folder
group_id string

Group ID (UUID string), shared between stories defined as alternates
alternates object[]
An array containing objects that provide basic data of the stories defined as alternates of the current story
Show child properties
- id number
  
  The numeric ID
- name string
  
  The complete name provided for the story
- slug string
  
  The slug specific for the story
- published boolean
  
  true if a story is currently published, even if it has unpublished changes.
- full_slug string
  
  The full slug of the story, combining the parent folder(s) and the designated story slug
- is_folder boolean
  
  true if the instance constitutes a folder
created_at string

Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
deleted_at string

Deleted date (Format: YYYY-mm-dd HH:MM)
sort_by_date string

Date defined in the story’s entry configuration (Format: YYYY-mm-dd)
tag_list string[]

Array of tag names
updated_at string

Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
published_at string

Latest publishing date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
uuid string

Generated UUID string
is_folder boolean

true if the instance constitutes a folder
content object

An object containing the field data associated with the specific story type’s specific content structure. Also includes a component property with the story type’s technical name.
published boolean

true if a story is currently published, even if it has unpublished changes.
slug string

The slug specific for the story
path string

Value of the real path defined in the story’s entry configuration (usually, this value is only required for Storyblok’s Visual Editor)
full_slug string

The full slug of the story, combining the parent folder(s) and the designated story slug
default_root string

Component name which will be used as default content type for this folders entries
disable_fe_editor boolean

Is side by side editor disabled for all entries in folder
parent object

Essential parent information as object (resolved from parent_id)
is_startpage boolean

true if the story is defined as root for the folder
unpublished_changes boolean

Story has unpublished changes; saved but not published
meta_data object

Object to store non-editable data that is exclusively maintained with the Management API
imported_at string

Latest import date (Format: YYYY-mm-dd HH:MM)
preview_token object
Preview token
Show child properties
- token string
  
  The token passed to the editor as preview parameter to allow edit mode verification
- timestamp string
  
  Timestamp passed to the editor as preview parameter to allow edit mode verification
pinned boolean

To pin the story in the toolbar
breadcrumbs object[]
Array of resolved subset of link objects (one per path segment / parent)
Show child properties
- id number
  
  Story ID
- name string
  
  The complete name provided for the story
- parent_id number
  
  ID of the parent folder
- disable_fe_editor boolean
  
  Is side by side editor disabled for all entries in folder
- path string
  
  Value of the real path defined in the story’s entry configuration (usually, this value is only required for Storyblok’s Visual Editor)
- slug string
  
  The slug specific for the story
- translated_slugs object[]
  Array of translated slug objects (if the app Translatable Slugs is installed)
  Show child properties
  
  story_id number
  
  ID of the story
  
  lang string
  
  Language code of the current language (can be requested with the language API parameter)
  
  slug string
  
  The slug specific for the story
  
  name string
  
  The complete name provided for the story
  
  published boolean
  
  true if a story is currently published, even if it has unpublished changes.
first_published_at string

First publishing date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
last_author object
Last author
Show child properties
- id number
  
  Last author user object numeric id
- userid string
  
  Last author userid/username
- friendly_name string
  
  Friendly name of last author
last_author_id number

Id of the last Author
translated_slugs object[]
Array of translated slug objects (if the app Translatable Slugs is installed)
Show child properties
- story_id number
  
  ID of the story
- lang string
  
  Language code of the current language (can be requested with the language API parameter)
- slug string
  
  The slug specific for the story
- name string
  
  The complete name provided for the story
- published boolean
  
  true if a story is currently published, even if it has unpublished changes.
translated_slugs_attributes object[]
Array of translated slug attributes objects (if the app Translatable Slugs is installed) to change translated slugs when creating or updating a story
Show child properties
- id number
  
  The numeric ID
- lang string
  
  Language code of the current language (can be requested with the language API parameter)
- slug string
  
  The slug specific for the story
- name string
  
  The complete name provided for the story
- published boolean
  
  true if a story is currently published, even if it has unpublished changes.
localized_paths object[]
An array of translated path objects
Show child properties
- path string
  
  Value of the real path defined in the story’s entry configuration (usually, this value is only required for Storyblok’s Visual Editor)
- name string
  
  The complete name provided for the story
- lang string
  
  Language code of the current language (can be requested with the language API parameter)
- published boolean
  
  true if a story is currently published, even if it has unpublished changes.
position number

Numeric representation of the story’s position in the folder
release_ids number[]

An array of release IDs associated with the story. Requires the Releases App ([] otherwise).
scheduled_dates string

Scheduled publishing date (Format: YYYY-mm-dd HH:MM)
favourite_for_user_ids number[]

Array of user IDs who have added the story in their favorites

{
   "story": {
       "name": "My third post",
       "parent_id": 0,
       "group_id": "2b29b0e9-bf7a-4443-b250-aa52a7ec64f2",
       "alternates": [],
       "created_at": "2023-05-29T09:53:40.231Z",
       "deleted_at": null,
       "sort_by_date": null,
       "tag_list": [],
       "updated_at": "2025-04-26T10:25:22.669Z",
       "published_at": "2024-04-26T10:25:22.654Z",
       "id": 369689,
       "uuid": "039508c6-e9fa-42b5-b952-c7d96ab6099d",
       "is_folder": false,
       "content": {
         "_uid": "98cccd01-f807-4494-996d-c6b0de2045a5",
         "component": "your_content_type"
         // fields you define yourself are in here
       },
       "published": true,
       "slug": "my-third-post",
       "path": null,
       "full_slug": "posts/my-third-post", // automatically generated
       "default_root": null,
       "disble_fe_editor": false,
       "parent": {
         "id": 369683,
         "slug": "posts",
         "name": "Posts",
         "disble_fe_editor": true,
         "uuid": "dcfcc350-e63e-4232-8dcb-ba4b8e70799d"
       },
       "is_startpage": false,
       "unpublished_changes": false,
       "meta_data": null,
       "imported_at": "2024-03-11T13:13:14.711Z",
       "preview_token": {
           "token": "279395174a25be38b702f9ec90d08a960e1a5a84",
           "timestamp": "1714129418"
       },
       "pinned": false,
       "breadcrumbs": [], /  // resolved full_slug parts
       "first_published_at": "2023-06-06T08:47:05.426Z",
       "last_author": {
           "id": 10961,
           "userid": "user@storyblok.com",
           "friendly_name": "Chakit Arora"
       },
       "last_author_id": 10961,
       "translated_slugs": [
           {
               "lang": "de",
               "slug": "the-german-blog-slug",
               "name": null,
               "published": null
           }
       ],
       "localized_paths": [
           {
               "path": "the-german-blog-slug",
               "name": null,
               "lang": "de",
               "published": true
           },
           // All locales present
       ],
       "position": 0,
       "scheduled_dates": "2025-05-08T18:59:00.000Z",
       "favorite_for_user_ids": [
           110930
       ]
   }
}

Get in touch with the Storyblok community

Cookie notice

The Story Object

Properties