Retrieve a Single Taxonomy Term

Retrieve a single taxonomy term and its sub-terms.

GET

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

Path parameters

• :id required string

  The taxonomy term’s name.

Query parameters

• token required string

  A preview or public access token configured in a space.

Response properties

• taxonomy_term TaxonomyTerm

  An object that contains a taxonomy.

  Show child properties

  • id string

    The taxonomy’s ID.

  • display_name string

    The taxonomy’s name.

  • name string

    The taxonomy’s technical name.

  • description string | null

    The taxonomy’s description.

  • parent_id string | null

    The top-level term’s ID.

  • last_author object | null

    An object that contains the details of user who created the term.

    Show child properties

    • id integer

      The user’s numeric ID.

    • userid string

      The user’s username or email address.

    • friendly_name string

      The user’s display name.

    • avatar string | null

      The URL of the user’s avatar image.

  • last_author_id string | null

    The user’s ID.

  • created_at string

    Creation timestamp. Supports ISO 8601.

  • updated_at string

    Latest update timestamp. Supports ISO 8601.

  • children array<TaxonomyTerm>

    An array of sub-terms objects.

    Show child properties

    • id string

      The taxonomy’s ID.

    • display_name string

      The taxonomy’s name.

    • name string

      The taxonomy’s technical name.

    • description string | null

      The taxonomy’s description.

    • parent_id string | null

      The top-level term’s ID.

    • last_author object | null

      An object that contains the details of user who created the term.

      Show child properties

      • id integer

        The user’s numeric ID.

      • userid string

        The user’s username or email address.

      • friendly_name string

        The user’s display name.

      • avatar string | null

        The URL of the user’s avatar image.

    • last_author_id string | null

      The user’s ID.

    • created_at string

      Creation timestamp. Supports ISO 8601.

    • updated_at string

      Latest update timestamp. Supports ISO 8601.

    • children array<TaxonomyTerm>

      An array of sub-terms objects.

    • terms_count integer

      The number sub-terms (at any depth).

    • last_activity_at string

      Latest update timestamp. Supports ISO 8601.

    • associated_content array<object>

      An array of story objects associated with the taxonomy.

      Show child properties

      • id string

        The associated story’s ID.

      • type string

        The associated block type’s name.

      • name string
      • full_slug string

        The story’s full slug, including parent folder and language paths.

      • updated_at string

        Latest update timestamp. Supports ISO 8601.

  • terms_count integer

    The number sub-terms (at any depth).

  • last_activity_at string

    Latest update timestamp. Supports ISO 8601.

  • associated_content array<object>

    An array of story objects associated with the taxonomy.

    Show child properties

    • id string

      The associated story’s ID.

    • type string

      The associated block type’s name.

    • name string
    • full_slug string

      The story’s full slug, including parent folder and language paths.

    • updated_at string

      Latest update timestamp. Supports ISO 8601.

• cv integer | null

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

Examples

cURL

curl "https://api.storyblok.com/v2/cdn/taxonomy_terms/:id\
?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/taxonomy_terms/:id', {})
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

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

$client->get('taxonomy_terms/:id')->getBody();

Java

HttpResponse<String> response = Unirest.get("https://api.storyblok.com/v2/cdn/taxonomy_terms/:id?token=YOUR_ACCESS_TOKEN")
  .asString();

C#

var client = new RestClient("https://api.storyblok.com/v2/cdn/taxonomy_terms/:id?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/taxonomy_terms/:id"

querystring = {"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.get('taxonomy_terms/:id')

Swift

let storyblok = URLSession(storyblok: .cdn(accessToken: "YOUR_ACCESS_TOKEN"))
let request = URLRequest(storyblok: storyblok, path: "taxonomy_terms/:id")
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("taxonomy_terms/:id")

println(response.body<JsonElement>())