The Space Object

This is an object representing a space. The space object contains all the information of one of your account spaces. Some of the properties are read-only, and others can be managed by the API.

Here we have mentioned a few important properties, but there can be more properties when you retrieve the space object. To see all of the properties, please try retrieving your space.

Properties

name
string

Name of the Space
domain
string

Domain for your default preview url
uniq_domain
string

Unique Domain for the Storyblok Rendering Service
plan
string

Space Plan
plan_level
number

Plan Level of Space
limits
object

Limits of the space
created_at
string

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

ID of the space
role
string

Role of the collaborator, could be admin, editor or custom roles
owner_id
number

Numeric user id of the owner for that space
story_published_hook
string

Published Webhook URL
environments
object[]

Array of name, location (url) objects
stories_count
number

Number of Stories in the Space
parent_id
number

Space id of a possible parent space
assets_count
number

Number of Assets in the Space
searchblok_id
number

Searchblok id, if available
duplicatable
boolean

Is the space globally duplicatable by all users
request_count_today
number

Request Count of the day
exceeded_requests
number

Number of Exceeded Requests
billing_address
object

Billing information used to generate your invoices for this space
routes
string[]

Routes for the Storyblok Rendering Service
trial
boolean

Is the space in trial mode
default_root
string

Component name which will be used as default content type for this folders entries
has_slack_webhook
boolean

Does the space have a slack webhook
has_pending_tasks
boolean

If the space has pending tasks like backup, deployment etc
first_token
string

The oldest available preview token of the space
options
object

Options for backup and language configurations

collaborator

The Collaborator Object

Array of Collaborators of the Space

user
object

The user object inside a collaborator object
- id
  number
  
  The user ID
- firstname
  string
  
  First name of collaborator
- lastname
  string
  
  Last name of collaborator
- alt_email
  string
  
  Email of collaborator
- avatar
  string
  
  Avatar of collaborator usually an image
- userid
  string
  
  User ID of collaborator
- friendly_name
  string
  
  Friendly name of collaborator
role
string

Role of the collaborator, could be admin, editor or custom roles
user_id
number

Numeric ID of the user

permissions

enum[]

Allow specific actions for collaborator in interface and add the permission as array of strings

Permission	Description
publish_stories	Allow publishing of content entries
save_stories	Allow editing and saving of content entries
edit_datasources	Allow editing and saving of datasources
access_commerce	Allow access to commerce app
edit_story_slug	Deny the change of slugs of content entries
move_story	Deny moving of content entries
view_composer	Deny access to visual composer

allowed_paths
number[]

Story ids the user should have access to (acts as whitelist). If no item is selected the user has rights to access all content items.
field_permissions
string[]

Hide specific fields for this user with an array of strings with the schema
id
number

Numeric id of collaborator
space_role_id
number

Numeric ID of the space role
space_role_ids
number[]

Array of space role ids
space_id
number

Numeric id of the collaborator space

owner
object

The user Object of the Owner

Example Object

{
  "space": {
    "name": "Example Space",
    "domain": "https://example.storyblok.com",
    "uniq_domain": null,
    "plan": "starter",
    "plan_level": 0,
    "limits": { },
    "created_at": "2018-11-10T15:33:18.402Z",
    "id": 680,
    "role": "admin",
    "owner_id": 1114,
    "story_published_hook": null,
    "environments": null,
    "stories_count": 1,
    "parent_id": null,
    "assets_count": 0,
    "searchblok_id": null,
    "duplicatable": null,
    "request_count_today": 0,
    "api_requests": 1000,
    "exceeded_requests": 0,
    "billing_address": { 
      // billing infromation
    },
    "routes": [ ],
    "euid": null,
    "trial": true,
    "default_root": "page",
    "has_slack_webhook": false,
    "api_logs_per_month": [ ],
    "first_token": "8IE7MzYCzw5d7KLckDa38Att",
    "has_pending_tasks": false,
    "options": { },
    "collaborators": [ ],
    "settings": [ ],
    "owner": {
      // user object
    }
  }
}

Example Space Options

"options": {
  "branch_deployed_hook": "", // Your webhook endpoint for branch deployments
  "s3_bucket": "storyblok-backup", // Your S3 bucket name
  "aws_arn": "arn:aws:iam::12312412:role/StoryblokRemote49122",
  "backup_frequency": "daily", 
  "languages": [ { "code": "de", "name": "German" } ]
}

Example Space Billing Address

"billing_address": {
  "tax_number": "ATU72706128", // Your VAT number
  "order_number": "Your custom order number",
  "company": "Storyblok GmbH",
  "email": "billing@storyblok.com", 
  "name": "Ing. Dominik Angerer", 
  "address_city": "Linz", 
  "address_country": "Austria", 
  "address_iso_country": "AT",
  "address_line1": "Peter-Behrens-Platz 1", 
  "address_zip": "4020", 
}

Prev Introduction

Next Retrieve a Single Space