The Space Object
The space object contains all information of one of your accounts spaces. Some of the properties are read only other can be managed by the API. Properties that you are able to change or use during creation can be found in the specific sections.
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
stringName of the Space
-
domain
stringDomain for your default preview url
-
uniq_domain
stringUnique Domain for the Storyblok Rendering Service
-
plan
stringSpace Plan
-
plan_level
numberPlan Level of Space
-
limits
objectLimits of the space
-
created_at
stringCreation date (Format:
yyyy-MM-dd'T'HH:mm:ssZ
) -
id
numberID of the space
-
role
stringRole of the collaborator, could be admin, editor or custom roles
-
owner_id
numberNumeric user id of the owner for that space
-
story_published_hook
stringPublished Webhook URL
-
environments
object[]Array of name, location (url) objects
-
stories_count
numberNumber of Stories in the Space
-
parent_id
numberSpace id of a possible parent space
-
assets_count
numberNumber of Assets in the Space
-
searchblok_id
numberSearchblok id, if available
-
duplicatable
booleanIs the space globally duplicatable by all users
-
request_count_today
numberRequest Count of the day
-
exceeded_requests
numberNumber of Exceeded Requests
-
billing_address
objectBilling information used to generate your invoices for this space
-
routes
string[]Routes for the Storyblok Rendering Service
-
trial
booleanIs the space in trial mode
-
default_root
stringComponent name which will be used as default content type for this folders entries
-
has_slack_webhook
booleanDoes the space have a slack webhook
-
first_token
stringThe oldest available preview token of the space
-
options
objectOptions for backup and language configurations
-
collaborator
The Collaborator ObjectArray of Collaborators of the Space
-
user
objectThe user object inside a collaborator object
-
id
numberThe user ID
-
firstname
stringFirst name of collaborator
-
lastname
stringLast name of collaborator
-
alt_email
stringEmail of collaborator
-
avatar
stringAvatar of collaborator usually an image
-
userid
stringUser ID of collaborator
-
friendly_name
stringFriendly name of collaborator
-
-
role
stringRole of the collaborator, could be admin, editor or custom roles
-
user_id
numberNumeric 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
numberNumeric id of collaborator
-
space_role_id
numberNumeric id of the space role connected with collaborators
-
space_role_ids
number[]Array of space role ids
-
space_id
numberNumeric id of the collaborator space
-
-
owner
objectThe 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,
"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
}
}
}
"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",
}