Site sections
Create and organize high-level sections for your docs site.
Sections help partition your site's content at the top level. They can be modified, deleted, or reorganized to reflect your site's changing structure.
The object type, which is always "site-section"
Unique identifier of the site section
Title of the site section
Description of the site section
Whether this is the default section for the site
Whether the site section is draft and not live.
Whether the site section is hidden. It is hidden when all of its site spaces are hidden, in which case it is not shown in the site's navigation.
Path to the section on the site
Conditional expression used to evaluate whether the site section should be shown to the site's visitor.
ID of the section group the section belongs to in the site
Name of the icon
gearThe SiteSection object
{
"object": "site-section",
"id": "text",
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"description": "text",
"localizedDescription": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"default": true,
"draft": true,
"hidden": 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-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
}
],
"urls": {
"published": "https://example.com"
},
"icon": "gear"
}Last updated
Was this helpful?