The Link Object

The link object contains a limited subset of the information associated with a story or folder.

Properties

• id number

  Story or folder ID

• uuid string

  Story or folder UUID

• slug string

  Story or folder full slug

• path string | null

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

• parent_id number | null

  Parent folder ID

• name string

  Story or folder name

• is_folder boolean

  true if the instance is a folder

• published boolean

  true if the instance is currently published

• is_startpage boolean

  true if the instance is a story and is defined as folder root

• position number

  Numeric representation of the story’s or folder’s position within the parent folder

• 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 /

• published_at string

  Latest 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)

• alternates array

  An array containing objects correlating to language versions defined using field-level translation. Important: not to be confused with story alternates defined using the Dimensions app in the context of folder-level translation.

  Show alternates object child properties

  • path string

    Translated story slug (see Translatable Slugs app)

  • name string

    Translated story name (see Translatable Slugs app)

  • lang string

    Language code of story language version

  • published boolean

    true if story language version is currently published

  • translated_slug string

    Translated story slug (see Translatable Slugs app)

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"
    }
  ]
}