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

Get navigation metadata links for a page (previous, next, parent)

Returns structural navigation metadata for a page, including references to the previous page, next page, and parent page within the space's hierarchy. Use this to implement or inspect linear navigation flows in a docs site without fetching the full page tree.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

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

A unique entity identifier

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

OK

application/json
canonicalone ofOptional
or
get/spaces/{spaceId}/content/page/{pageId}/meta-links
GET /v1/spaces/{spaceId}/content/page/{pageId}/meta-links HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "canonical": {
    "kind": "page",
    "page": "text",
    "space": "text"
  },
  "alternates": [
    {
      "kind": "page",
      "page": "text",
      "space": "text"
    }
  ]
}

Last updated

Was this helpful?

Powered by GitBook