Retrieve a Single Link

Retrieve a single link object by its UUID.

GET

https://api.storyblok.com/v2/cdn/links/:id

Path parameters

• :id required string

  The link’s ID.

Query parameters

• cv integer

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

• include_dates string

  Include or exclude the created_at, updated_at and published_at fields. To include these date fields in the response, set to 1. To exclude them, set to 0 or omit the parameter.

• token required string

  A preview or public access token configured in a space.

Response properties

• link Link
  Show child properties

  • id integer
    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. Learn more in the Visual Editor concept).
  • real_path string | null
    Either the full slug of the story or folder with a leading /, or the value of the real path defined in the story’s entry configuration with a leading /.
  • name string
    Story or folder name.
  • published boolean
    Returns true if the story is currently published.
  • parent_id integer
    Parent folder ID.
  • is_folder boolean
    Returns true if the item is a folder.
  • is_startpage boolean
    Returns true if the story is the folder’s root.
  • position integer
    Numeric representation of the story’s position in the folder. Users can change this property in the Content tab.
  • published_at string | null
    Latest publication timestamp. Supports ISO 8601.
  • created_at string | null
    Creation timestamp. Supports ISO 8601.
  • updated_at string | null
    Latest update timestamp. Supports ISO 8601.
  • alternates array<Alternate>

    An array that contains objects correlating to the language versions defined using field-level translation.

    The alternates parameter is different from the story alternates defined in the Dimensions app when using folder-level translation.

    Show child properties

    • path string
      Translated story slug (learn more about the Translatable Slugs app).
    • name string
      Translated story name (learn more about the Translatable Slugs app).
    • lang string
      The story’s language code.
    • published boolean
      Returns true if story language version is currently published.
    • translated_slug string
      Translated story slug (learn more about the Translatable Slugs app).

Examples

cURL

curl "https://api.storyblok.com/v2/cdn/links/:id\
?version=published\
&starts_with=articles\
&token=YOUR_ACCESS_TOKEN"

JS

// storyblok-js-client@>=7, node@>=18
import Storyblok from "storyblok-js-client";

const storyblok = new Storyblok({
  accessToken: "krcV6QGxWORpYLUWt12xKQtt",
});

try {
  const response = await storyblok.get('cdn/links/:id', {
    "version": "published",
    "starts_with": "articles"
  })
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

$client = new \Storyblok\Client('YOUR_STORYBLOK_SPACE_ACCESS_TOKEN');

$client->getLinks([
  "version" => "published",
  "starts_with" => "articles"
])->getBody();

Java

HttpResponse<String> response = Unirest.get("https://api.storyblok.com/v2/cdn/links/:id?version=published&starts_with=articles&token=YOUR_ACCESS_TOKEN")
  .asString();

C#

var client = new RestClient("https://api.storyblok.com/v2/cdn/links/:id?version=published&starts_with=articles&token=YOUR_ACCESS_TOKEN");
var request = new RestRequest(Method.GET);

IRestResponse response = client.Execute(request);

Python

import requests

url = "https://api.storyblok.com/v2/cdn/links/:id"

querystring = {"version":"published","starts_with":"articles","token":"YOUR_ACCESS_TOKEN"}

payload = ""
headers = {}

response = requests.request("GET", url, data=payload, headers=headers, params=querystring)

print(response.text)

Ruby

require 'storyblok'
client = Storyblok::Client.new(token: 'YOUR_TOKEN')

client.links({:params => {
  "version" => "published",
  "starts_with" => "articles"
}})

Swift

let storyblok = URLSession(storyblok: .cdn(accessToken: "YOUR_ACCESS_TOKEN"))
var request = URLRequest(storyblok: storyblok, path: "links/:id")
request.url!.append(queryItems: [
    URLQueryItem(name: "version", value: "published"),
    URLQueryItem(name: "starts_with", value: "articles")
])
let (data, _) = try await storyblok.data(for: request)
print(try JSONSerialization.jsonObject(with: data))

Kotlin

val client = HttpClient {
    install(Storyblok(CDN)) {
        accessToken = "YOUR_ACCESS_TOKEN"
    }
}

val response = client.get("links/:id") {
    url {
        parameters.append("version", "published")
        parameters.append("starts_with", "articles")
    }
}

println(response.body<JsonElement>())

Response

{
"link": {
  "id": 371891025,
  "uuid": "a78b2116-c26d-4d23-9cbe-fec477847b0e",
  "slug": "home",
  "path": null,
  "real_path": "/home",
  "name": "Home",
  "published": true,
  "parent_id": 0,
  "is_folder": false,
  "is_startpage": true,
  "position": 0,
  "published_at": "2025-01-15T09:32:10.000Z",
  "created_at": "2025-01-15T09:30:00.000Z",
  "updated_at": "2025-06-02T14:12:05.000Z",
  "alternates": []
}
}