Stories

Retrieve a Single Story

Changed on

Retrieve a single story by full slug, ID, or UUID. Includes parameters for resolving links and relations.

get/v2/cdn/stories/{id}

Request

Path parameters

idstring required
Example:startpage

The story’s id, uuid, or full_slug.

Query parameters

find_bystring
Example:uuid

Required when using the story uuid as a path parameter.

version'draft' | 'published'
Example:published

The content version to retrieve: draft or published. Default is published. Retrieving draft requires a preview access token.

resolve_links'story' | 'url' | 'link'
Example:story

Resolve link fields. The links property of the response includes resolved links:

  • link: provides access to additional information, such as a linked story’s full_slug, path, parent_id, is_folder, published, is_startpage, position, alternates, real_path, and more.
  • url: provides the minimum amount of information. Use when you only need the path of a linked story.
  • story: resolves and returns the complete story object of a linked story.
resolve_links_level1 | 2
Example:1

Resolve up to two levels of links.

resolve_links_in_relations1
Example:1

To resolve the links inside related stories, set resolve_links_in_relations=1. This parameter requires both resolve_relations and resolve_links.

The links property of the response includes both the story’s own links and the ones returned from the related stories.

Links in resolve_level=2 relations remain unresolved.

When exceeding the limit, the response includes link_uuids instead of links.

resolve_relationsstring
Example:page.author,page.categories

Used to resolve referenced stories. Resolved stories appear in the rels property of the response.

A single request can resolve up to 50 stories. Afterward, all story UUID appear in the rel_uuids property of the response and need to resolve in subsequent API requests.

To resolve the stories selected in one field, provide the technical name of the immediate parent component of the field, followed by a . and the field name. To resolve the stories selected in multiple fields, provide a comma-separated string.

Example: resolve_relations=page.author,page.categories.

from_releasestring
Example:1

Access a story version in a specific release by providing the release ID.

content_typestring
Example:page

Retrieve stories of a specific content type block. For example, content_type=page.

cvinteger
Example:1121

Cached version Unix timestamp. Learn more in the Caching concept.

excluding_fieldsstring
Example:title,body

To exclude specific fields of a content type, provide the field names as a comma-separated string. For example, excluding_fields=body,meta_description.

Excluding the component field from the response returns the content of the story in the default language instead of the requested language.

When a request has both excluding_fields and including_fields, the API ignores excluding_fields.

including_fieldsstring
Example:title,body

To return only specific fields of a content type, provide the field names as a comma-separated string. For example, including_fields=title,image.

The response always returns _uid, component, and _editable, as well as translated versions of a listed field.

Takes precedence over excluding_fields.

excluding_story_fieldsstring
Example:alternates,translated_slugs

Exclude top-level story response fields with a comma-separated list. For example, excluding_story_fields=alternates,translated_slugs.

languagestring
Example:de

Retrieve translated story version. Supports languages defined in Settings → Internationalization.

fallback_langstring
Example:de

Define a custom fallback language to handle untranslated fields. Supports languages defined in Settings → Internationalization. Provide language code with underscores. For example, es_co instead of es-co.

resolve_assetsinteger
Example:1

Used to resolve asset metadata, including custom metadata. When resolve_assets=1, an array of assets associated with the stories appear in the assets property of the response.

resolve_level2
Example:2

Used to force resolve second-level relations when the first level reaches a limit of 100 relations.

While resolving relations, if the first level exceeds 100 relations, the API stops looking for the second level. To resolve second-level relations regardless of the first-level relations’ limit, use resolve_level=2.

tokenstring required
Example:ask9soUkv02QqbZgmZdeDAtt

A preview or public access token configured in a space.

Response

Story Found

cvinteger required

Cached version Unix timestamp. Learn more in the Caching concept.

rel_uuidsstring[]

An array of all referenced stories’ UUIDs.

link_uuidsstring[]

An array of all linked stories’ UUIDs.

Example response

{
  "story": {
    "name": "Home",
    "created_at": "2025-07-09T14:35:26.851Z",
    "updated_at": "2025-07-09T14:35:26.851Z",
    "published_at": "2025-07-09T14:35:26.851Z",
    "alternates": [
      {
        "id": 12345,
        "name": "Home ES",
        "slug": "home-es",
        "published": true,
        "full_slug": "home-es"
      }
    ],
    "id": 1,
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "content": {
      "_uid": "54bac0c7-bf25-46d0-ba66-a0ea51091a8d",
      "body": [
        {
          "_uid": "57c35684-7f72-43f4-a965-16f328392882",
          "headline": "Hello world!!",
          "component": "teaser"
        },
        {
          "_uid": "9fd8401d-3ac9-4c4a-90af-0cb091487abe",
          "columns": [
            {
              "_uid": "eb7e436b-e19f-4bd1-87d4-2edd44389ded",
              "name": "Feature 1",
              "component": "feature"
            }
          ],
          "component": "grid"
        }
      ],
      "component": "page"
    },
    "slug": "home",
    "full_slug": "home",
    "default_full_slug": "home/",
    "sort_by_date": "2025-07-09T14:35:26.851Z",
    "position": 1,
    "tag_list": [
      "home"
    ],
    "is_startpage": true,
    "parent_id": 1,
    "meta_data": {},
    "group_id": "57350688-5a28-49d1-b5a9-086ae0d4c0d2",
    "first_published_at": "2025-07-09T14:35:26.851Z",
    "release_id": 1,
    "lang": "default",
    "path": "/home",
    "translated_slugs": [
      {
        "path": "library/",
        "name": "library",
        "lang": "es",
        "published": true
      }
    ],
    "taxonomy_terms": [
      {
        "id": "12345",
        "display_name": "Laptops",
        "name": "laptops",
        "taxonomy_id": "100"
      }
    ]
  },
  "cv": 1234,
  "rels": [
    {
      "name": "Home",
      "created_at": "2025-07-09T14:35:26.851Z",
      "updated_at": "2025-07-09T14:35:26.851Z",
      "published_at": "2025-07-09T14:35:26.851Z",
      "alternates": [
        {
          "id": 12345,
          "name": "Home ES",
          "slug": "home-es",
          "published": true,
          "full_slug": "home-es"
        }
      ],
      "id": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "content": {
        "_uid": "54bac0c7-bf25-46d0-ba66-a0ea51091a8d",
        "body": [
          {
            "_uid": "57c35684-7f72-43f4-a965-16f328392882",
            "headline": "Hello world!!",
            "component": "teaser"
          },
          {
            "_uid": "9fd8401d-3ac9-4c4a-90af-0cb091487abe",
            "columns": [
              {
                "_uid": "eb7e436b-e19f-4bd1-87d4-2edd44389ded",
                "name": "Feature 1",
                "component": "feature"
              }
            ],
            "component": "grid"
          }
        ],
        "component": "page"
      },
      "slug": "home",
      "full_slug": "home",
      "default_full_slug": "home/",
      "sort_by_date": "2025-07-09T14:35:26.851Z",
      "position": 1,
      "tag_list": [
        "home"
      ],
      "is_startpage": true,
      "parent_id": 1,
      "meta_data": {},
      "group_id": "57350688-5a28-49d1-b5a9-086ae0d4c0d2",
      "first_published_at": "2025-07-09T14:35:26.851Z",
      "release_id": 1,
      "lang": "default",
      "path": "/home",
      "translated_slugs": [
        {
          "path": "library/",
          "name": "library",
          "lang": "es",
          "published": true
        }
      ],
      "taxonomy_terms": [
        {
          "id": "12345",
          "display_name": "Laptops",
          "name": "laptops",
          "taxonomy_id": "100"
        }
      ]
    }
  ],
  "links": [
    {
      "id": 123,
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "website-a/home",
      "path": "the-real-path",
      "real_path": "/the-real-path",
      "name": "Home",
      "published": true,
      "parent_id": 123,
      "is_folder": true,
      "is_startpage": true,
      "position": 2,
      "published_at": "2025-07-09T14:35:26.851Z",
      "created_at": "2025-07-09T14:35:26.851Z",
      "updated_at": "2025-07-09T14:35:26.851Z",
      "alternates": [
        {
          "path": "/home",
          "name": "Home",
          "lang": "en",
          "published": true,
          "translated_slug": "home"
        }
      ],
      "full_slug": "es/posts/mi-casa"
    }
  ],
  "rel_uuids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "link_uuids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Changes

    • info

      added the new optional query request parameter including_fields

    • info

      added the new optional query request parameter resolve_links_in_relations