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.

The Space object

Attributes

objectstring · enumRequired

Type of Object, always equals to "space"

Possible values:

idstringRequired

Unique identifier for the space

titlestring · max: 50Required

Title of the space

emojistring · emoji · max: 50Required

An emoji for this space. It'll match the emoji shown in the GitBook app.

Example: 🎉

visibilitystring · enumRequired

• 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 engines
• share-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.

Possible values:

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

deletedAtstring · date-timeOptional

editModestring · enumOptional

Determines how a Space can be edited.

• live: Users can directly edit the space
• locked: All edits are locked for this space.

Possible values:

typestring · enumOptional

Kind of space. Only set to styleguide for spaces holding a team's writing styleguide; omitted for regular spaces.

Possible values:

mergeRulesone ofRequired

or

or

organizationstringRequired

ID of the organization owning this space

parentstringOptional

ID of the parent collection.

languagestring · enumOptionalPossible values:

visitorAuthone ofOptional

or

revisionstringRequired

ID of the active revision in the space.

defaultLevelone ofRequired

Default level for a piece of content

string · enumOptional

"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.

Possible values:

or

nullOptional

or

string · enumOptionalPossible values:

commentsnumberRequired

Count of opened comments on the space.

changeRequestsnumberRequired

Total count of change requests on the space.

changeRequestsOpennumberRequired

Count of open change requests on the space.

changeRequestsDraftnumberRequired

Count of draft change requests on the space.

internal_poweredByV2booleanOptional

Whether the space is powered by V2 of the content system.

internal_singleWebsocketbooleanOptional

Whether the space uses a single websocket connection for all real-time communication.

The Space object

{
  "object": "space",
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "visibility": "public",
  "createdAt": "2026-07-21T19:19:03.739Z",
  "updatedAt": "2026-07-21T19:19:03.739Z",
  "deletedAt": "2026-07-21T19:19:03.739Z",
  "editMode": "live",
  "type": "styleguide",
  "mergeRules": {
    "type": "inherit"
  },
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "published": "https://example.com",
    "public": "https://example.com",
    "icon": "https://example.com"
  },
  "organization": "text",
  "parent": "text",
  "language": "en",
  "gitSync": {
    "repoName": "text",
    "installationStatus": "unauthenticated",
    "installationProvider": "github",
    "installationId": "text",
    "url": "text",
    "operation": {
      "state": "running"
    },
    "updatedAt": "2026-07-21T19:19:03.739Z"
  },
  "visitorAuth": {
    "backend": "custom"
  },
  "revision": "text",
  "defaultLevel": "admin",
  "comments": 1,
  "changeRequests": 1,
  "changeRequestsOpen": 1,
  "changeRequestsDraft": 1,
  "internal_poweredByV2": true,
  "internal_singleWebsocket": true,
  "permissions": {
    "view": true,
    "access": true,
    "admin": true,
    "viewInviteLinks": true,
    "edit": true,
    "triggerGitSync": true,
    "comment": true,
    "merge": true,
    "review": true,
    "installIntegration": true
  }
}