The Story Object

The following object represents a story. A story’s schema is defined in the Block Library within Storyblok. The content type determines the content structure of a story via the definition of fields. This specific structure is found in the content property of the story object, whereas the other properties are generic and included in all story objects.

Properties

• name string
  Story name
• published_at string

  Latest publication timestamp (Timestamps follow the ISO 8601 standard in UTC)

• first_published_at string
  First publication timestamp (Timestamps follow the ISO 8601 standard in UTC)
• created_at string

  Creation timestamp (Timestamps follow the ISO 8601 standard in UTC)

• updated_at string

  Latest update timestamp (Timestamps follow the ISO 8601 standard in UTC)

• id number
  Story ID
• uuid string
  Story UUID
• content object
  An object containing the field data associated with a content type’s specific structure. Also includes a component property with the content type’s technical name.
• slug string
  Story
• full_slug string
  Story full slug, combining the parent folder(s) and the story slug
• sort_by_date string | null
  Date defined in the story’s entry configuration (Format: YYYY-mm-dd)
• position number
  Numeric representation of the story’s position in the folder. Users can change this property in the Content tab.
• tag_list array[string]
  Array of tag names
• is_startpage boolean
  true if the story is defined as folder root
• parent_id number
  Parent folder ID
• meta_data object | null
  Object to store non-editable data that is exclusively maintained with the Management API
• group_id string
  Group ID (UUID string), shared between stories defined as alternates
• release_id number | null
  Current release ID (if requested via the from_release parameter)
• lang string
  Language code of the current language version (if requested via the language parameter)
• path string | null

  Real path defined in the story’s entry configuration (see Visual Editor)

• alternates array[object]

  An array containing objects that provide basic data of the stories defined as alternates of the current story.

  Show child properties

  • id number
    Story ID
  • name string
    Story name
  • slug string
    Story slug
  • published boolean
    true if the story is currently published
  • full_slug string
    Story full slug, combining the parent folder(s) and the story slug
  • is_folder boolean
    true if the instance constitutes a folder
  • parent_id number
    ID of the parent folder
• default_full_slug string | null
  Contains the complete slug of the default language (if the Translatable Slugs app is installed)
• translated_slugs array[object] | null

  Array of translated slug objects (if the Translatable Slugs app is installed)

  Show child properties

  • path string
    Translated slug
  • name string
    Translated name
  • lang string
    Language code of story variant
  • published boolean
    true if story variant is currently published

Example Object

{
  "story": {
    "name": "My third post",
    "created_at": "2024-02-08T16:26:24.425Z",
    "published_at": "2024-02-08T16:27:05.705Z",
    "id": 440448565,
    "uuid": "e656e146-f4ed-44a2-8017-013e5a9d9395",
    "content": {
      "_uid": "cfe0ff0b-3211-4bb7-8128-66e6ad262a56",
      "component": "page"
    },
    "slug": "my-third-post",
    "full_slug": "posts/my-third-post",
    "sort_by_date": null,
    "position": 0,
    "tag_list": [],
    "is_startpage": false,
    "parent_id": 440448337,
    "meta_data": null,
    "group_id": "b913a671-f1e9-436a-bc5d-2795d2740198",
    "first_published_at": "2024-02-08T16:27:05.705Z",
    "release_id": null,
    "lang": "default",
    "path": null,
    "alternates": [
      {
        "id": 440452827,
        "name": "Mein dritter Beitrag",
        "slug": "mein-dritter-beitrag",
        "published": true,
        "full_slug": "beitraege/mein-dritter-beitrag",
        "is_folder": false,
        "parent_id": 440452826
      }
    ],
    "default_full_slug": "posts/my-third-post",
    "translated_slugs": [
      {
        "path": "posts/my-third-post",
        "name": null,
        "lang": "fr",
        "published": null
      },
      {
        "path": "posts/mein-dritter-beitrag",
        "name": "Mein dritter Beitrag",
        "lang": "de",
        "published": true
      }
    ]
  }
}