List all spaces in an organization

Returns a paginated list of all spaces belonging to the organization. A space is a collection of documentation pages with its own content tree and revision history. Use this to discover spaces before reading their content, adding them to a site, or performing operations on specific spaces.

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

Responses

200

OK

application/json

countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/spaces

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "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",
        "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"
      },
      "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
      }
    }
  ]
}