Retrieve Multiple Spaces

GET

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

Returns an array of space objects.

Note

This endpoint returns a simplified space object with fewer properties than the retrieve a single space endpoint.

Response properties

• spaces object[]

  An array of space objects.

  Show child properties

  • name string

    Name of the space.

  • id number

    Numeric ID of the space.

  • region string

    Region of the space.

  • owner_id number

    Numeric ID of the space owner.

  • updated_at string

    Last update date (Format: yyyy-MM-dd'T'HH:mm:ssZ).

  • plan string

    Space plan name.

  • requires_2fa boolean

    Indicates if two-factor authentication is required.

  • created_at string

    Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ).

  • org_id number

    Organization ID if the space belongs to an organization.

  • space_type string

    Type of the space.

  • space_roles object[]

    Available roles in the space.

Examples

cURL

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

JS

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

const storyblok = new Storyblok({
  oauthToken: "YOUR_PERSONAL_ACCESS_TOKEN",
});

try {
  const response = await storyblok.get('spaces/', {})
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

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

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

Java

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

C#

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/");
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/"

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/')

Swift

let storyblok = URLSession(storyblok: .mapi(accessToken: .oauth("YOUR_OAUTH_TOKEN")))
let request = URLRequest(storyblok: storyblok, path: "spaces/")
let (data, _) = try await storyblok.data(for: request)
print(try JSONSerialization.jsonObject(with: data))

Kotlin

val client = HttpClient {
    install(Storyblok(MAPI)) {
        accessToken = OAuth("YOUR_OAUTH_TOKEN")
    }
}

val response = client.get("spaces/")

println(response.body<JsonElement>())