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

Get a page from a space by its URL path

Retrieves a page by its URL path (e.g. /guides/getting-started) from the space's current revision. Use this when you have a page's path rather than its ID. Returns either a document page or a group/section page depending on the path.

Available in MCP
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

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

The path of the page in the revision.

Query parameters
formatstring · enumOptional

Output format for the content.

Possible values:
format.markdown.refsstring · enumOptional

Controls how content references are formatted in markdown output. Ignored unless format=markdown.

  • relative: Format page references as relative links from the current page. Other references might not be handled.
  • stable: Format content references as stable idempotent refs containing their identifiers.
Default: relativePossible values:
evaluatedone ofOptional

Controls whether the document should be evaluated.

  • When set to true, the entire document will be evaluated.
  • When set to deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.
Default: false
booleanOptional
or
string · enumOptionalPossible values:
dereferencedone ofOptional

Controls whether the document should be deferenced (eference to other content will be resolved and expanded).

  • When set to true, the entire document will be deferenced
  • When set to reusable-contents, only reusable contents will be deferenced.
Default: false
booleanOptional
or
string · enumOptionalPossible values:
metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true
computedbooleanOptional

If false is passed, content will not be computed

Default: true
Responses
200

OK

application/json
or
get/spaces/{spaceId}/content/path/{pagePath}
GET /v1/spaces/{spaceId}/content/path/{pagePath} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "text",
  "title": "text",
  "linkTitle": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "condition": "text",
  "markdown": "# Hello World\n\nThis is a markdown document linking to [another page](/pages/page_id).\n",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "pages": [
    "[Circular Reference]"
  ],
  "git": {
    "oid": "text",
    "path": "text"
  },
  "layout": {
    "width": "default",
    "cover": true,
    "coverSize": "hero",
    "coverMask": "none",
    "title": true,
    "description": true,
    "tableOfContents": true,
    "outline": true,
    "pagination": true,
    "metadata": true,
    "tags": true,
    "actions": true
  },
  "cover": {
    "ref": {
      "kind": "file",
      "file": "text",
      "space": "text"
    },
    "refDark": {
      "kind": "file",
      "file": "text",
      "space": "text"
    },
    "textColor": "black",
    "textColorDark": "black",
    "yPos": 0,
    "height": 240
  },
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "hidden": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "metaLinks": {
    "canonical": {
      "kind": "page",
      "page": "text",
      "space": "text"
    },
    "alternates": [
      {
        "kind": "page",
        "page": "text",
        "space": "text"
      }
    ]
  },
  "tags": [
    {
      "tag": {
        "kind": "tag",
        "tag": "text",
        "space": "text"
      },
      "primary": true
    }
  ],
  "computed": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "computedSeed": "text"
}

Last updated

Was this helpful?

Powered by GitBook