For the complete documentation index, see llms.txt. This page is also available as Markdown.

Site section groups

Group and manage sections of your docs for easier organization.

Section groups let you bundle multiple top-level sections together, offering additional structuring capabilities and simplifying navigation for your readers.

The SiteSectionGroup object

Attributes

objectstring · enumRequired

The object type, which is always "site-section-group"

Possible values:

idstringRequired

Unique identifier of the site section group

titlestring · min: 1 · max: 100Required

Title of the site section group

sectionGroupstringOptional

ID of the parent section group this group belongs to

draftbooleanRequired

Whether the site section group is draft and not live.

iconstring · icon · max: 50Optional

Name of the icon

Example: gear

The SiteSectionGroup object

List all section groups in a site's navigation structure

get

Returns a paginated list of section groups for the site. Section groups are containers that organize multiple sections into a hierarchical navigation structure. Use this to inspect the current grouping before adding, updating, or reordering items in the site structure.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

application/json

countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/sites/{siteId}/section-groups

200

Add a section group to a site's navigation structure

post

Creates a new section group to organize multiple sections under a shared navigation label. Section groups can be nested by providing a parent group ID. Existing sections can be assigned to the group at creation time via their IDs. Create the group in draft mode to stage it before publishing.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Body

titlestring · min: 1 · max: 100Required

Title of the site section group

iconone ofOptional

string · icon · max: 50Optional

Name of the icon

Example: gear

nullOptional

sectionsstring[]Optional

IDs of the sections to be added to the section group

parentstringOptional

ID of the parent section group to nest this group under. If not provided, the section group will be added at the root of the site.

draftbooleanOptional

Whether the section group should be created in draft mode.

Responses

201

Section group added to the site

application/json

post/orgs/{organizationId}/sites/{siteId}/section-groups

201

Section group added to the site

Delete a site section group

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

siteSectionGroupIdstringRequired

The unique id of the site group

Responses

204

Site section group did not exist

205

Site section group has been deleted

delete/orgs/{organizationId}/sites/{siteId}/section-groups/{siteSectionGroupId}

No content

Update a section group in a site's navigation structure

patch

Updates a section group's properties in the site's navigation structure.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

siteSectionGroupIdstringRequired

The unique id of the site group

Body

titlestring · min: 1 · max: 100Optional

Title of the site section group

iconone ofOptional

string · icon · max: 50Optional

Name of the icon

Example: gear

nullOptional

draftbooleanOptional

Whether the site section group should be kept in draft mode. Setting it to true makes the site section group draft. Setting it to false makes the site section group live.

Responses

200

application/json

objectstring · enumRequired

The object type, which is always "site-section-group"

Possible values:

idstringRequired

Unique identifier of the site section group

titlestring · min: 1 · max: 100Required

Title of the site section group

sectionGroupstringOptional

ID of the parent section group this group belongs to

draftbooleanRequired

Whether the site section group is draft and not live.

iconstring · icon · max: 50Optional

Name of the icon

Example: gear

patch/orgs/{organizationId}/sites/{siteId}/section-groups/{siteSectionGroupId}

200

Deprecated

Move a site section group to a new position. (Deprecated) use sortSiteStructure instead.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

siteSectionGroupIdstringRequired

The unique id of the site group

Body

Responses

200

Site section group moved

application/json

objectstring · enumRequired

The object type, which is always "site-section-group"

Possible values:

idstringRequired

Unique identifier of the site section group

titlestring · min: 1 · max: 100Required

Title of the site section group

sectionGroupstringOptional

ID of the parent section group this group belongs to

draftbooleanRequired

Whether the site section group is draft and not live.

iconstring · icon · max: 50Optional

Name of the icon

Example: gear

400

Invalid move site section group position provided

application/json

404

No matching site section group found

application/json

post/orgs/{organizationId}/sites/{siteId}/section-groups/{siteSectionGroupId}/move

Last updated 12 hours ago

Was this helpful?

{ "object": "site-section-group", "id": "text", "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "sectionGroup": "text", "draft": true, "children": [ { "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月03日T02:15:01.687Z", "updatedAt": "2026年07月03日T02:15:01.687Z", "deletedAt": "2026年07月03日T02:15:01.687Z", "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", "updatedAt": "2026年07月03日T02:15:01.687Z" }, "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" } ], "icon": "gear" }

{ "next": { "page": "text" }, "count": 1, "items": [ { "object": "site-section-group", "id": "text", "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "sectionGroup": "text", "draft": true, "children": [ { "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月03日T02:15:01.687Z", "updatedAt": "2026年07月03日T02:15:01.687Z", "deletedAt": "2026年07月03日T02:15:01.687Z", "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", "updatedAt": "2026年07月03日T02:15:01.687Z" }, "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" } ], "icon": "gear" } ] }