Spaces
Create, maintain, and remove content spaces.
Spaces are containers for your documentation or knowledge base content. Use this API to create new spaces, manage existing ones, and delete or archive spaces you no longer need.
Type of Object, always equals to "space"
Unique identifier for the space
Title of the space
An emoji for this space. It'll match the emoji shown in the GitBook app.
🎉public: Anyone can access the content, and the content is indexed by search engines.unlisted: Anyone can access the content, and the content is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the content.visitor-auth: Anyone authenticated through a JWT token can access the content.in-collection: Anyone who can access the parent collection can access the content. Only available for spaces in a collection.private: Authorized members can access the content.
Determines how a Space can be edited.
live: Users can directly edit the spacelocked: All edits are locked for this space.
Kind of space. Only set to styleguide for spaces holding a team's writing styleguide; omitted for regular spaces.
ID of the organization owning this space
ID of the parent collection.
ID of the active revision in the space.
Default level for a piece of content
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Count of opened comments on the space.
Total count of change requests on the space.
Count of open change requests on the space.
Count of draft change requests on the space.
Whether the space is powered by V2 of the content system.
Whether the space uses a single websocket connection for all real-time communication.
The Space object
Returns the full metadata for a space. Use this to resolve a spaceId into a complete Space object. If you only need content, use the content endpoint instead.
A unique entity identifier
^[a-zA-Z0-9_-]+$For sites published via share-links, the share key is useful to resolve published URLs.
OK
Type of Object, always equals to "space"
Unique identifier for the space
Title of the space
An emoji for this space. It'll match the emoji shown in the GitBook app.
🎉public: Anyone can access the content, and the content is indexed by search engines.unlisted: Anyone can access the content, and the content is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the content.visitor-auth: Anyone authenticated through a JWT token can access the content.in-collection: Anyone who can access the parent collection can access the content. Only available for spaces in a collection.private: Authorized members can access the content.
Determines how a Space can be edited.
live: Users can directly edit the spacelocked: All edits are locked for this space.
Kind of space. Only set to styleguide for spaces holding a team's writing styleguide; omitted for regular spaces.
ID of the organization owning this space
ID of the parent collection.
ID of the active revision in the space.
Default level for a piece of content
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Count of opened comments on the space.
Total count of change requests on the space.
Count of open change requests on the space.
Count of draft change requests on the space.
Whether the space is powered by V2 of the content system.
Whether the space uses a single websocket connection for all real-time communication.
OK
Deleted spaces will be permanently removed after 7 days.
A unique entity identifier
^[a-zA-Z0-9_-]+$Space did not exist
Space has been deleted
No content
Updates a space's metadata and settings. To update page content, use the change-request workflow instead.
A unique entity identifier
^[a-zA-Z0-9_-]+$The space has been updated
Type of Object, always equals to "space"
Unique identifier for the space
Title of the space
An emoji for this space. It'll match the emoji shown in the GitBook app.
🎉public: Anyone can access the content, and the content is indexed by search engines.unlisted: Anyone can access the content, and the content is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the content.visitor-auth: Anyone authenticated through a JWT token can access the content.in-collection: Anyone who can access the parent collection can access the content. Only available for spaces in a collection.private: Authorized members can access the content.
Determines how a Space can be edited.
live: Users can directly edit the spacelocked: All edits are locked for this space.
Kind of space. Only set to styleguide for spaces holding a team's writing styleguide; omitted for regular spaces.
ID of the organization owning this space
ID of the parent collection.
ID of the active revision in the space.
Default level for a piece of content
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Count of opened comments on the space.
Total count of change requests on the space.
Count of open change requests on the space.
Count of draft change requests on the space.
Whether the space is powered by V2 of the content system.
Whether the space uses a single websocket connection for all real-time communication.
The space has been updated
Creates a new space that is a complete copy of the specified space, including all pages and their content. The duplicate is created in the same organization. Returns the newly created space. Use this to create a template-based copy or to snapshot a space before making large changes.
A unique entity identifier
^[a-zA-Z0-9_-]+$Space duplicated
Space duplicated
Restores a previously deleted space, making it active again. Only spaces deleted within the last 7 days can be restored; after that they are permanently removed. Returns the restored space object. To delete a space, use the space delete endpoint.
A unique entity identifier
^[a-zA-Z0-9_-]+$Space restored
Type of Object, always equals to "space"
Unique identifier for the space
Title of the space
An emoji for this space. It'll match the emoji shown in the GitBook app.
🎉public: Anyone can access the content, and the content is indexed by search engines.unlisted: Anyone can access the content, and the content is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the content.visitor-auth: Anyone authenticated through a JWT token can access the content.in-collection: Anyone who can access the parent collection can access the content. Only available for spaces in a collection.private: Authorized members can access the content.
Determines how a Space can be edited.
live: Users can directly edit the spacelocked: All edits are locked for this space.
Kind of space. Only set to styleguide for spaces holding a team's writing styleguide; omitted for regular spaces.
ID of the organization owning this space
ID of the parent collection.
ID of the active revision in the space.
Default level for a piece of content
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Count of opened comments on the space.
Total count of change requests on the space.
Count of open change requests on the space.
Count of draft change requests on the space.
Whether the space is powered by V2 of the content system.
Whether the space uses a single websocket connection for all real-time communication.
Space restored
Moves a space to a new parent collection and/or a new position within the hierarchy.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the parent collection
Space moved
Type of Object, always equals to "space"
Unique identifier for the space
Title of the space
An emoji for this space. It'll match the emoji shown in the GitBook app.
🎉public: Anyone can access the content, and the content is indexed by search engines.unlisted: Anyone can access the content, and the content is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the content.visitor-auth: Anyone authenticated through a JWT token can access the content.in-collection: Anyone who can access the parent collection can access the content. Only available for spaces in a collection.private: Authorized members can access the content.
Determines how a Space can be edited.
live: Users can directly edit the spacelocked: All edits are locked for this space.
Kind of space. Only set to styleguide for spaces holding a team's writing styleguide; omitted for regular spaces.
ID of the organization owning this space
ID of the parent collection.
ID of the active revision in the space.
Default level for a piece of content
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Count of opened comments on the space.
Total count of change requests on the space.
Count of open change requests on the space.
Count of draft change requests on the space.
Whether the space is powered by V2 of the content system.
Whether the space uses a single websocket connection for all real-time communication.
Invalid position space or collection provided
No matching Space found for given ID
Operation would not result in any update
Returns a paginated list of all internal and external links found in the space's content. Use this to audit link health across an entire space.
A unique entity identifier
^[a-zA-Z0-9_-]+$Identifier of the page results to fetch.
The number of results per page
Text to display to represent the reference. Possible values include:
ok- No problems detected for this content reference.broken- The target does not exist in the revision.in-app- The target is a URL link pointing to an internal location in the app.
OK
Total count of objects in the list
The space could not be found.
Returns a paginated list of all spaces belonging to the organization. A space is a collection of documentation pages with its own content tree and revision history. Use this to discover spaces before reading their content, adding them to a site, or performing operations on specific spaces.
A unique entity identifier
^[a-zA-Z0-9_-]+$Identifier of the page results to fetch.
The number of results per page
OK
Total count of objects in the list
OK
Creates a new space within the organization. A space is the primary container for documentation content, holding pages, files, and revisions. After creation, add the space to a site to make it publicly accessible, or start adding content directly via the space content endpoints.
A unique entity identifier
^[a-zA-Z0-9_-]+$Space created
Space created
Last updated
Was this helpful?