The Story Object

An object that represents a content entry. A story object can be any content type, including a folder, and may contain blocks and fields that match its predefined content structure.

Use the story object to compose stories and other entries when migrating or importing content.

Properties

id number

Numeric ID of the story.
name string

The name of the story.
parent_id number

The ID of the story’s parent folder. Set to 0 for root-level stories.
group_id string

A UUID shared between stories defined as alternates.
alternates object[]
An array of minimal story objects defined as alternates of the current story (usually used for internationalization or variants).
Show child properties
- id number
  
  Numeric ID of the story.
- name string
  
  The name of the story.
- slug string
  
  The slug of the story.
- published boolean
  
  Is the story currently published.
- full_slug string
  
  The full slug of the story, which combines the parent folder(s) and the designated story slug.
- is_folder boolean
  
  Is the content entry a folder.
- parent_id number
  
  The ID of the story’s parent folder. Set to 0 for root-level stories.
created_at string

The story creation date and time (format: ISO UTC timestamp).
deleted_at string

The story deletion date and time (format: ISO UTC timestamp).
sort_by_date string

Date defined in the story’s configuration (format: ISO UTC datestamp). Use with the Content Delivery API’s sort_by parameter.
tag_list string[]

An array of tags assigned to the story.
updated_at string

Latest update date and time (format: ISO UTC timestamp).
published_at string

Latest publishing date and time (format: ISO UTC timestamp).
uuid string

UUID of the story.
is_folder boolean

Is the content entry a folder.
content object

An object that contains all blocks and fields that represents the story’s content structure. Includes a component property with the content type’s technical name.
published boolean

Is the story currently published.
slug string

The slug of the story.
path string

The Real path defined in the story’s configuration (learn more in the Visual Editor concept).
full_slug string

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

The technical name of the content type block used as default for stories in this folder.
disable_fe_editor boolean

Is the Visual Editor disabled.
parent object

An object with a subset of the story’s parent folder (resolved from parent_id).
is_startpage boolean

Is the story defined as the root story of its parent folder.
unpublished_changes boolean

Does the story have unpublished changes.
meta_data object

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

Latest import date and time (format: ISO UTC timestamp).
preview_token object
The preview token.
Show child properties
- token string
  
  The token passed to the editor as preview parameter to allow edit mode verification.
- timestamp string
  
  The timestamp passed to the editor as preview parameter to allow edit mode verification.
pinned boolean

A legacy UI feature replaced by favourite_for_user_ids.
breadcrumbs object[]
An array of link objects. A subset of the Content Delivery API’s links endpoint.
Show child properties
- id number
  
  Numeric ID of the story.
- name string
  
  The name of the story.
- parent_id number
  
  The ID of the story’s parent folder. Set to 0 for root-level stories.
- disable_fe_editor boolean
  
  Is the Visual Editor disabled for all entries in the folder.
- path string
  
  The Real path defined in the story’s configuration (learn more in the Visual Editor concept).
- slug string
  
  The slug of the story.
- translated_slugs object[]
  An array of translated slug objects (requires the Translatable Slugs app).
  Show child properties
  
  id number
  
  Numeric ID of the translated slug.
  
  lang string
  
  ISO code of the current language (use the Content Delivery API’s language parameter for the request).
  
  slug string
  
  The translated slug of the story.
  
  name string
  
  The translated name of the story.
  
  published boolean
  
  Is the story currently published.
first_published_at string

First publishing date and time (format: ISO UTC timestamp).
last_author object
A subset of a collaborator object that represents the last user who interacted with the story.
Show child properties
- id number
  
  Numeric ID of the user.
- userid string
  
  User ID of a collaborator.
- friendly_name string
  
  Friendly name of a collaborator.
last_author_id number

Numeric ID of the last user who interacted with the story.
user_ids number[]

An array of user IDs assigned to a workflow stage.
space_role_ids number[]

An array of space role IDs assigned to a workflow stage.
translated_slugs object[]
An array of translated slug objects (requires the Translatable Slugs app).
Show child properties
- id number
  
  Numeric ID of the translated slug.
- lang string
  
  ISO code of the current language (use the Content Delivery API’s language parameter for the request).
- slug string
  
  The translated slug of the story.
- name string
  
  The translated name of the story.
- published boolean
  
  Is the story currently published.
translated_slugs_attributes object[]
Array of translated slug attributes objects (requires the Translatable Slugs.
Show child properties
- id number
  
  Numeric ID of the translated slug.
- lang string
  
  ISO code of the current language (use the Content Delivery API’s language parameter for the request).
- slug string
  
  The translated slug of the story.
- name string
  
  The translated name of the story.
- published boolean
  
  Is the story currently published.
localized_paths object[]
An array of translated slug objects (requires the Translatable Slugs app).
Show child properties
- path string
  
  The full translated slug of the story, which combines the parent folder(s) and the designated story slug.
- name string
  
  The translated name of the story.
- lang string
  
  ISO code of the current language (use the Content Delivery API’s language parameter for the request).
- published boolean
  
  Is the story currently published.
position number

Numeric representation of the story’s position in the folder. Users can change this property in the Content tab.
release_ids number[]

An array of release IDs associated with the story. Requires the Releases App.
current_version_id number

The version ID of the story’s latest content (within the release). Requires the Releases App.
base_version_id number

The version ID of the story’s content when it was first added to the release. Requires the Releases App.
main_version_id number

The version ID of the story’s current content (outside the release). Requires the Releases App.
scheduled_dates string

Scheduled publishing date and time (format: ISO UTC timestamp).
stage object
Details of the story’s current workflow stage.
Show child properties
- workflow_id number
  
  Numeric ID of the current workflow.
- workflow_stage_id number
  
  Numeric ID of the current workflow stage.
- story_id number
  
  Numeric ID of the story.
- due_date string
  
  The date and time the story should move to the next workflow stage (format: ISO UTC timestamp). Once this deadline passes, Storyblok automatically notifies the assigned user.
- created_at string
  
  The workflow creation date and time (format: ISO UTC timestamp).
favourite_for_user_ids number[]

An array of user IDs who saved the story as Favorite.

{
   "story": {
       "name": "My third article",
       "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": "content_type"
         // All blocks and fields
       },
       "published": true,
       "slug": "my-third-post",
       "path": null,
       "full_slug": "articles/my-third-article", // automatically generated
       "default_root": null,
       "disable_fe_editor": false,
       "parent": {
         "id": 369683,
         "slug": "posts",
         "name": "Posts",
         "disable_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"
       },
       "breadcrumbs": [
             {
               "id": 123316305875825,
               "name": "artikel",
               "parent_id": null,
               "disable_fe_editor": false,
               "path": null,
               "slug": "artikel",
               "translated_slugs": [
                 {
                   "id": 123380337827976,
                   "lang": "es",
                   "slug": "spanish-article-slug",
                   "name": "Spanish article name",
                   "published": null
                 }
               ]
             }
        ],
       "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": [
             {
               "id": 123316380093025,
               "lang": "de",
               "slug": "german-article-slug",
               "name": "German article name",
               "published": null
             }
           ],
           "localized_paths": [
             {
               "path": "artikel/german-article-slug",
               "name": "German article name",
               "lang": "de",
               "published": null
             },
             {
               "path": "articulos/spanish-article-slug",
               "name": null,
               "lang": "es",
               "published": null
             }
             // All other defined locales
           ],
       "position": 0,
       "scheduled_dates": "2025-05-08T18:59:00.000Z",
       "favourite_for_user_ids": [
           10961
       ]
   }
}

Was this page helpful?

This site uses reCAPTCHA and Google's Privacy Policy. Terms of Service apply.

Get in touch with the Storyblok community

Cookie notice

The Story Object

Properties