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.
Properties
Section titled “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
- 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
- ai_translation_disabled boolean
Legacy (no longer in use). Used to enable or disable AI translations.
- 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
Show child properties
- user object
The user object inside a collaborator object
Show child properties
- 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 read_stories View stories without editing save_stories Edit and save stories publish_stories Publish stories to the live environment unpublish_stories Unpublish stories from the live environment publish_folders Publish entire folders and their contents unpublish_folders Unpublish folders and their contents deploy_stories Deploy pipeline stories delete_stories Permanently delete stories edit_image Edit images in the asset manager view_composer View the Visual Editor change_alternate_group Change alternate content groupings (for i18n or variants) move_story Move stories between folders edit_story_slug Edit the URL slug of a story view_content Controls visibility of content entries. Without this, all content is hidden unless explicitly granted. To give read-only access to others, enable allow reading content permission. view_folders Controls visibility of folders. Without this, all folders are hidden unless explicitly granted. To give read-only access to others, enable allow reading content permission. view_draft_json View the draft JSON payload of stories view_published_json View the published JSON payload of stories manage_tags Create, edit, or delete tags edit_datasources Edit datasources edit_datasource_keys Edit keys inside datasources access_commerce Access commerce-related features manage_block_library Manage components in the Block Library hide_asset_folders Hides assets and folders (including subfolders) that the role doesn’t have upload permission for. In the UI, you can specify which folders are accessible. - 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
{"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, "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 }}}"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" } ]}"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",}Get in touch with the Storyblok community