Site structure

Retrieve and manipulate the entire hierarchical layout of a site.

Provides a complete overview of how content is organized on a site. With this API, you can discover page nesting, identify sections, and reorder site elements as needed.

The SiteStructure object

Attributes

or

The SiteStructure object

{
  "type": "sections",
  "structure": [
    {
      "object": "site-section",
      "id": "text",
      "title": "text",
      "localizedTitle": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "description": "text",
      "localizedDescription": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "default": true,
      "draft": true,
      "path": "text",
      "condition": "text",
      "sectionGroup": "text",
      "siteSpaces": [
        {
          "object": "site-space",
          "id": "text",
          "path": "text",
          "section": "text",
          "space": {
            "object": "space",
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "visibility": "public",
            "createdAt": "2026-07-21T20:56:44.702Z",
            "updatedAt": "2026-07-21T20:56:44.702Z",
            "deletedAt": "2026-07-21T20:56:44.702Z",
            "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-21T20:56:44.702Z"
            },
            "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",
          "draft": true,
          "hasAdvancedCustomizationFeature": true,
          "urls": {
            "published": "https://example.com"
          },
          "hidden": true
        }
      ],
      "urls": {
        "published": "https://example.com"
      },
      "icon": "gear"
    }
  ]
}