--- title: The Space Object description: An object that represents a space. Some properties are read-only, and others can be managed by the API. url: https://storyblok.com/docs/api/management/spaces/the-space-object --- # The Space Object An object that represents a space. You can manage many properties via the API, but some are read-only. > [!TIP] > The following list includes only a sample of available properties. To view the full list, [retrieve the space object](/docs/api/management/spaces/retrieve-a-single-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 name. - `plan_level` (number) Space plan level. - `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 and location (url) objects. - `stories_count` (number) Number of stories in the space. - `parent_id` (number) Space ID of a 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 invoices for this space. - `routes` (string\[\]) Routes for the Storyblok Rendering Service. - `trial` (boolean) Indicates if the space is in trial mode. - `default_root` (string) Block name used as the default content type for entries in this folder. - `has_slack_webhook` (boolean) Indicates if the space uses a Slack webhook. - `first_token` (string) The space’s oldest available preview token. - `has_pending_tasks` (boolean) Indicates if the space has pending tasks, such as backup, deployment, etc. - `options` (object) Options for backup and language configurations. - `owner` (object) The user object of the space owner. - `collaborators` (object\[\]) Array of collaborators in the space. Show child properties - `user` (object) The user object inside a collaborator object. Show child properties - `id` (number) Numeric ID of a user. - `firstname` (string) First name of collaborator. - `lastname` (string) Last name of a collaborator. - `alt_email` (string) Email of a collaborator. - `avatar` (string) Avatar of a collaborator (usually an image file). - `userid` (string) User ID of a collaborator. - `friendly_name` (string) Friendly name of a collaborator. - `role` (string) Role of the collaborator. Could be admin, editor, or custom roles. - `user_id` (number) Numeric ID of the user. - `permissions` (enum\[\]) An array of strings that define the role’s permissions. > [!TIP] > Find the full list of permissions in the [space role object](/docs/api/management/space-roles/the-space-role-object/) reference page. | Permission | Description | | --- | --- | | `read_stories` | Read-only access to stories | | `save_stories` | Edit and save stories | | `publish_stories` | Publish stories | | `unpublish_stories` | Unpublish stories | | `publish_folders` | Publish folders (including stories contained within) | | `unpublish_folders` | Unpublish folders (including stories contained within) | | `deploy_stories` | Deploy pipeline stories | | `delete_stories` | Permanently delete stories | | `edit_image` | Edit images in the Image Editor | | `view_composer` | Use the Visual Editor | | `change_alternate_group` | Change alternate content groupings (for internationalization or variants) | | `move_story` | Move stories between folders | | `edit_story_slug` | Edit a story URL | | `view_content` | If checked, hides all stories except those defined in `allowed_paths` (**Permissions** → **Content** → **Folder/Content item permissions**) | | `view_folders` | If checked, hides all folders except those defined in `allowed_paths` (**Permissions** → **Content** → **Folder/Content item permissions**) | | `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 datasources keys | | `access_commerce` | Access e-commerce features (if available) | | `manage_block_library` | Create, move, and edit blocks and folders | | `hide_asset_folders` | If checked, hides all assets and folders except those defined in `asset_folder_ids` (**Permissions** → **Assets** → **Asset Folder Permissions**) | - `allowed_paths` (number\[\]) An array of story IDs that the role can access. If none is selected, all stories are accessible. - `field_permissions` (string\[\]) An array of fields visible to this role (based on the block schema). If none is selected, all fields are visible. - `id` (number) Numeric ID of a collaborator. - `space_role_id` (number) Numeric ID associated with a single custom role. - `space_role_ids` (number\[\]) An array of numeric IDs associated with each custom role assigned to a single collaborator. - `space_id` (number) Numeric ID of the collaborator’s space. Endpoint Object ```json { "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 } } } ``` Example Space Options ```json "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 ```json "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", } ``` ## Pagination - [Previous: Retrieve Multiple Spaces](/docs/api/management/spaces/retrieve-multiple-spaces) - [Next: Update a Space](/docs/api/management/spaces/update-a-space)