The Link Object

The Link Object contains a limited subset of the information associated with a story (a content entry) or a folder.

Properties

id
number

The numeric ID
uuid
string

Generated UUID string
slug
string

The full slug of the story or folder
path
string

Value of the real path defined in the story's entry configuration
real_path
string

Either the full slug of the story or folder with a leading /, or, if existent, the value of the real path defined in the story's entry configuration with a leading /
name
string

The complete name of the story or folder
published
boolean

true if a story has been published at least once (even if it is currently in draft)
parent_id
number

ID of the parent folder
is_folder
boolean

true if the instance constitutes a folder
is_startpage
boolean

true if the story is defined as root for the folder
position
number

Numeric representation of the story's position in the folder
published_at
string

Latest publishing date (Format: yyyy-MM-dd'T'HH:mm:ssZ); only included if include_dates=1 is specified
created_at
string

Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ); only included if include_dates=1 is specified
updated_at
string

Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ); only included if include_dates=1 is specified
alternates
object

An array containing objects that provide basic data of the different language versions of a story using Storyblok's Field Level Translation. Important: not to be confused with actual story alternates.
- path
  string
  
  Translated slug of the story (if the app Translatable Slugs is installed; otherwise, it matches the slug of the parent object)
- name
  string
  
  Translated name of the story (if the app Translatable Slugs is installed)
- lang
  string
  
  Language code of this story variant
- published
  boolean
  
  true if a story has been published at least once (even if it is currently in draft)
- translated_slug
  string
  
  Translated slug of the story (if the app Translatable Slugs is installed; otherwise, it matches the slug of the parent object)

Example Object

{
  "id": 460947950,
  "uuid": "3ce5d163-3bb4-41ef-9e1a-709d7c4848ff",
  "slug": "website-a/home",
  "path": "the-real-path",
  "parent_id": 460950252,
  "name": "Home",
  "is_folder": false,
  "published": true,
  "is_startpage": false,
  "position": 10,
  "real_path": "/the-real-path",
  "published_at": "2024-03-07T18:32:44.919Z",
  "created_at": "2024-03-07T18:22:10.389Z",
  "updated_at": "2024-03-07T18:32:44.933Z",
  "alternates": [
    {
      "path": "website-a/startseite",
      "name": "Startseite",
      "lang": "de",
      "published": true,
      "translated_slug": "website-a/startseite"
    }
  ]
}

Prev The Links Object

Next Retrieve Multiple Links