Site spaces

Control which spaces are linked and displayed in a docs site.

Associate or dissociate your organization's spaces to keep your content organized. This is particularly useful for larger organizations with numerous spaces.

The SiteSpace object

Attributes

objectstring · enumRequired

The object type, which is always "site-space"

Possible values:

idstringRequired

Unique identifier of the site-space

pathstring · min: 1 · max: 100Required

Path to the space on the site

sectionstringOptional

ID of the section the space belongs to in the site

titlestringRequired

defaultbooleanOptional

Whether this is the default space for the site

conditionstring · max: 1024Optional

Conditional expression used to evaluate whether the site space should be shown to the site's visitor.

pageIdstring · nullableOptional

Custom home page within the space, rendered at the site space's path root instead of the space's default landing page.

draftbooleanRequired

Whether the site space is draft and not live.

hasAdvancedCustomizationFeaturebooleanOptional

Whether the space has advanced customization feature enabled

hiddenbooleanOptional

Whether the site space is hidden. If true, the site space will not be shown in the site's navigation.

The SiteSpace object

{
  "object": "site-space",
  "id": "text",
  "path": "text",
  "section": "text",
  "space": {
    "object": "space",
    "id": "text",
    "title": "text",
    "emoji": "🎉",
    "visibility": "public",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "deletedAt": "2026-01-01T00:00:00.000Z",
    "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",
      "parentInstallationId": "text",
      "url": "text",
      "installationProjectDirectory": "text",
      "operation": {
        "state": "running",
        "direction": "export",
        "startedAt": "2026-01-01T00:00:00.000Z",
        "endedAt": "2026-01-01T00:00:00.000Z",
        "error": "text",
        "errorAction": {
          "label": "text",
          "url": "https://example.com"
        }
      },
      "operationTimeout": 1,
      "updatedAt": "2026-01-01T00:00:00.000Z"
    },
    "previousGitSync": {
      "url": "text"
    },
    "imports": [
      {
        "object": "import-run",
        "id": "text",
        "startedAt": "2026-01-01T00:00:00.000Z",
        "completedAt": "2026-01-01T00:00:00.000Z",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "status": "pending",
        "reason": "text",
        "source": {
          "type": "website",
          "url": "https://example.com"
        },
        "target": {
          "space": "text",
          "changeRequest": "text",
          "page": "text"
        },
        "site": "text",
        "createdBy": "text",
        "urls": {
          "location": "https://example.com"
        },
        "pages": [
          {
            "id": "text",
            "sourceURL": "text",
            "type": "page",
            "status": "complete"
          }
        ]
      }
    ],
    "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
    }
  },
  "title": "text",
  "localizedTitle": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "default": true,
  "condition": "text",
  "pageId": "text",
  "draft": true,
  "hasAdvancedCustomizationFeature": true,
  "urls": {
    "published": "https://example.com"
  },
  "hidden": true
}