Retrieve Multiple Tags

Returns an array of tag objects used in a space. The response includes only tags assigned to at least one story.

GET

https://api.storyblok.com/v2/cdn/tags

Query parameters

• starts_with string

  Filter by the story’s full_slug to return items starting with the given value.

• version string

  Filter by the story’s publication status.

• filter_query object

  Learn more in Filter Queries.

• token required string

  A preview or public access token configured in a space.

Response properties

• tags array<Tag>

  An array of tag objects.

  Show child properties

  • name string

    The tag name.

  • taggings_count integer

    The number of stories that include this tag.

  • tag_on_stories integer

    The number of distinct stories this tag appears on (only present when all_tags parameter is true).

Examples

cURL

curl "https://api.storyblok.com/v2/cdn/tags\
?starts_with=articles%2F\
&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/tags', {
    "starts_with": "articles/"
  })
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

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

$client->getTags([
  "starts_with" => "articles/"
])->getBody();

Java

HttpResponse<String> response = Unirest.get("https://api.storyblok.com/v2/cdn/tags?starts_with=articles%2F&token=YOUR_ACCESS_TOKEN")
  .asString();

C#

var client = new RestClient("https://api.storyblok.com/v2/cdn/tags?starts_with=articles%2F&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/tags"

querystring = {"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.tags({:params => {
  "starts_with" => "articles/"
}})

Swift

let storyblok = URLSession(storyblok: .cdn(accessToken: "YOUR_ACCESS_TOKEN"))
var request = URLRequest(storyblok: storyblok, path: "tags")
request.url!.append(queryItems: [
    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("tags") {
    url {
        parameters.append("starts_with", "articles/")
    }
}

println(response.body<JsonElement>())

Response

{
"tags": [
  {
    "name": "spicy",
    "taggings_count": 5
  },
  {
    "name": "red",
    "taggings_count": 3
  }
]
}