The State of Docs Survey 2025. Use your voice to prove why docs matter:
Take the survey
Product
PricingLog inSign up

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"

Allowed values:
idstringRequired

Unique identifier of the site section group

titlestring · min: 1 · max: 100Required

Title of the site section group

iconstring · icon · max: 50Optional

Name of the icon

Example: gear

The SiteSectionGroup object

{
  "object": "site-section-group",
  "id": "text",
  "title": "text",
  "sections": [
    {
      "object": "site-section",
      "id": "text",
      "title": "text",
      "description": "text",
      "default": 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": "2025-04-21T17:41:43.179Z",
            "updatedAt": "2025-04-21T17:41:43.179Z",
            "deletedAt": "2025-04-21T17:41:43.179Z",
            "editMode": "live",
            "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",
            "gitSync": {
              "repoName": "text",
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2025-04-21T17:41:43.179Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": true
            }
          },
          "title": "text",
          "default": true,
          "condition": "text",
          "hasAdvancedCustomizationFeature": true,
          "urls": {
            "published": "https://example.com"
          }
        }
      ],
      "urls": {
        "published": "https://example.com"
      },
      "icon": "gear"
    }
  ],
  "icon": "gear"
}

List all site section groups

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

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
application/json
all ofOptional
get
GET /v1/orgs/{organizationId}/sites/{siteId}/section-groups HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-section-group",
      "id": "text",
      "title": "text",
      "sections": [
        {
          "object": "site-section",
          "id": "text",
          "title": "text",
          "description": "text",
          "default": 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": "2025-04-21T17:41:43.179Z",
                "updatedAt": "2025-04-21T17:41:43.179Z",
                "deletedAt": "2025-04-21T17:41:43.179Z",
                "editMode": "live",
                "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",
                "gitSync": {
                  "repoName": "text",
                  "installationProvider": "github",
                  "integration": "text",
                  "url": "text",
                  "updatedAt": "2025-04-21T17:41:43.179Z"
                },
                "visitorAuth": {
                  "backend": "custom"
                },
                "revision": "text",
                "defaultLevel": "admin",
                "comments": 1,
                "changeRequests": 1,
                "changeRequestsOpen": 1,
                "changeRequestsDraft": 1,
                "permissions": {
                  "access": true,
                  "admin": true,
                  "edit": true,
                  "comment": true,
                  "merge": true,
                  "review": true
                }
              },
              "title": "text",
              "default": true,
              "condition": "text",
              "hasAdvancedCustomizationFeature": true,
              "urls": {
                "published": "https://example.com"
              }
            }
          ],
          "urls": {
            "published": "https://example.com"
          },
          "icon": "gear"
        }
      ],
      "icon": "gear"
    }
  ]
}

Add a section group to a site

post
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

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
string · enum | nullableOptionalAllowed values:
sectionsstring[]Optional

IDs of the sections to be added to the section group

Responses
application/json
post
POST /v1/orgs/{organizationId}/sites/{siteId}/section-groups HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "title": "text",
  "icon": "gear",
  "sections": [
    "text"
  ]
}
201

Section group added to the site

{
  "object": "site-section-group",
  "id": "text",
  "title": "text",
  "sections": [
    {
      "object": "site-section",
      "id": "text",
      "title": "text",
      "description": "text",
      "default": 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": "2025-04-21T17:41:43.179Z",
            "updatedAt": "2025-04-21T17:41:43.179Z",
            "deletedAt": "2025-04-21T17:41:43.179Z",
            "editMode": "live",
            "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",
            "gitSync": {
              "repoName": "text",
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2025-04-21T17:41:43.179Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": true
            }
          },
          "title": "text",
          "default": true,
          "condition": "text",
          "hasAdvancedCustomizationFeature": true,
          "urls": {
            "published": "https://example.com"
          }
        }
      ],
      "urls": {
        "published": "https://example.com"
      },
      "icon": "gear"
    }
  ],
  "icon": "gear"
}

Delete a site section group

delete
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteSectionGroupIdstringRequired

The unique id of the site group

Responses
delete
DELETE /v1/orgs/{organizationId}/sites/{siteId}/section-groups/{siteSectionGroupId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
205

Site section group has been deleted

No content

Update a site section group

patch
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

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
string · enum | nullableOptionalAllowed values:
Responses
application/json
patch
PATCH /v1/orgs/{organizationId}/sites/{siteId}/section-groups/{siteSectionGroupId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "title": "text",
  "icon": "gear"
}
200

OK

{
  "object": "site-section-group",
  "id": "text",
  "title": "text",
  "sections": [
    {
      "object": "site-section",
      "id": "text",
      "title": "text",
      "description": "text",
      "default": 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": "2025-04-21T17:41:43.179Z",
            "updatedAt": "2025-04-21T17:41:43.179Z",
            "deletedAt": "2025-04-21T17:41:43.179Z",
            "editMode": "live",
            "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",
            "gitSync": {
              "repoName": "text",
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2025-04-21T17:41:43.179Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": true
            }
          },
          "title": "text",
          "default": true,
          "condition": "text",
          "hasAdvancedCustomizationFeature": true,
          "urls": {
            "published": "https://example.com"
          }
        }
      ],
      "urls": {
        "published": "https://example.com"
      },
      "icon": "gear"
    }
  ],
  "icon": "gear"
}

Add a section to a section group

post
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteSectionGroupIdstringRequired

The unique id of the site group

Body
sectionIdstringRequired

ID of the section to add to the section group

Responses
application/json
post
POST /v1/orgs/{organizationId}/sites/{siteId}/section-groups/{siteSectionGroupId}/sections HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "sectionId": "text"
}
201

Section added to the section group

{
  "object": "site-section-group",
  "id": "text",
  "title": "text",
  "sections": [
    {
      "object": "site-section",
      "id": "text",
      "title": "text",
      "description": "text",
      "default": 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": "2025-04-21T17:41:43.179Z",
            "updatedAt": "2025-04-21T17:41:43.179Z",
            "deletedAt": "2025-04-21T17:41:43.179Z",
            "editMode": "live",
            "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",
            "gitSync": {
              "repoName": "text",
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2025-04-21T17:41:43.179Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": true
            }
          },
          "title": "text",
          "default": true,
          "condition": "text",
          "hasAdvancedCustomizationFeature": true,
          "urls": {
            "published": "https://example.com"
          }
        }
      ],
      "urls": {
        "published": "https://example.com"
      },
      "icon": "gear"
    }
  ],
  "icon": "gear"
}

Remove a section from a section group

delete
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteSectionGroupIdstringRequired

The unique id of the site group

siteSectionIdstringRequired

The unique id of the section within a site

Responses
delete
DELETE /v1/orgs/{organizationId}/sites/{siteId}/section-groups/{siteSectionGroupId}/sections/{siteSectionId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
205

Section has been removed from the section group

No content

Move a site section group to a new position

post
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteSectionGroupIdstringRequired

The unique id of the site group

Body
Responses
application/json
post
POST /v1/orgs/{organizationId}/sites/{siteId}/section-groups/{siteSectionGroupId}/move HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "position": {
    "before": {
      "type": "site-section",
      "id": "text"
    },
    "after": {
      "type": "site-section",
      "id": "text"
    }
  }
}
{
  "object": "site-section-group",
  "id": "text",
  "title": "text",
  "sections": [
    {
      "object": "site-section",
      "id": "text",
      "title": "text",
      "description": "text",
      "default": 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": "2025-04-21T17:41:43.179Z",
            "updatedAt": "2025-04-21T17:41:43.179Z",
            "deletedAt": "2025-04-21T17:41:43.179Z",
            "editMode": "live",
            "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",
            "gitSync": {
              "repoName": "text",
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2025-04-21T17:41:43.179Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": true
            }
          },
          "title": "text",
          "default": true,
          "condition": "text",
          "hasAdvancedCustomizationFeature": true,
          "urls": {
            "published": "https://example.com"
          }
        }
      ],
      "urls": {
        "published": "https://example.com"
      },
      "icon": "gear"
    }
  ],
  "icon": "gear"
}

Was this helpful?