Retrieve Multiple Components

https://mapi.storyblok.com/v1/spaces/:space_id/components

Retrieve an array of component objects.

This endpoint also returns information about component folders (groups) in a separate key named component_groups.

Path parameters

• :space_id required number

  Numeric ID of a space

Query parameters

• by_ids string

  Filter by comma-separated IDs

• sort_by string

  Sort components an ascending or descending order by a specific property. Following are a few options and examples:

  • Retrieve content type blocks first: is_nestable:asc,is_root:desc
  • Retrieve nestable blocks first: is_nestable:desc,is_root:asc
  • Retrieve universal blocks first: is_nestable:desc,is_root:desc

  This endpoint also supports properties like name and updated_at.

• is_root boolean

  Retrieve components based on their is_root property:

  • Set to true to retrieve all the components that can be used as content type blocks
  • Set to false to retrieve all the nestable blocks.
• search string

  Search by name or display_name

• in_group string

  Find components in a specific folder using its UUID

Response properties

• components The Component Object[]

  An array of component objects

• component_groups The Component Folder Object[]

  An array of component folder objects

Examples

cURL

curl "https://mapi.storyblok.com/v1/spaces/656/components/" \
  -H "Authorization: YOUR_OAUTH_TOKEN"

JS client

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.get('spaces/656/components/', {})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP client

$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$client->get('spaces/656/components/')->getBody();

Java

HttpResponse<String> response = Unirest.get("https://mapi.storyblok.com/v1/spaces/656/components/")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/656/components/");
var request = new RestRequest(Method.GET);

request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/656/components/"

querystring = {}

payload = ""
headers = {
  'Authorization': "YOUR_OAUTH_TOKEN"
}

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

print(response.text)

Ruby

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

client.get('spaces/656/components/')

Swift

import Foundation

let headers = [
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/656/components/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()