List all documentation sites in an organization

Returns a paginated list of all documentation sites belonging to the organization. Use this to discover available sites before fetching their content, settings, or structure. Members with access only to individual spaces receive the sites that use those spaces as site items, with site administration fields omitted.

Available in MCP

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

spacestringOptional

Identifier of the space to filter the sites by

titlestringOptional

Filter sites by their title

publishedbooleanOptional

Filter sites by their published status

Responses

200

OK

application/json

countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/sites

GET /v1/orgs/{organizationId}/sites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site",
      "id": "text",
      "type": "basic",
      "appliedType": "basic",
      "unpublishedBy": "user",
      "title": "text",
      "icon": {
        "icon": {
          "light": "https://example.com",
          "dark": "https://example.com"
        }
      },
      "hostname": "text",
      "basename": "text",
      "proxy": {
        "origin": "text",
        "target": "text"
      },
      "visibility": "public",
      "defaultLevel": "admin",
      "permissions": {
        "view": true,
        "access": true,
        "edit": true,
        "create": true,
        "admin": true,
        "installIntegration": true,
        "viewAdaptiveSchema": true,
        "editAdaptiveSchema": true
      },
      "published": true,
      "siteSpaces": 1,
      "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"
      },
      "createdAt": "2026-01-01T00:00:00.000Z",
      "lastScanAt": "2026-01-01T00:00:00.000Z",
      "adaptiveContent": {
        "enabled": true
      },
      "ads": {
        "status": "pending",
        "submittable": true
      },
      "styleguide": {
        "kind": "space",
        "space": "text"
      },
      "features": [
        {
          "id": "sites-adaptive-content",
          "plan": "basic",
          "frozen": true,
          "customizations": [
            "header-logo"
          ]
        }
      ],
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com",
        "published": "https://example.com",
        "preview": "https://example.com",
        "login": "https://example.com",
        "logout": "https://example.com"
      }
    }
  ]
}