List all pages in a change request as a flat list
Returns the full flat list of all pages in the change request's current draft revision, including page groups. Does not include page body content — use the individual page endpoint to fetch content. Use this to get an overview of the draft's page structure before reading or modifying specific pages.
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequiredPattern:
A unique entity identifier
^[a-zA-Z0-9_-]+$changeRequestIdstringRequiredPattern:
A unique entity identifier
^[a-zA-Z0-9_-]+$Query parameters
metadatabooleanOptionalDefault:
If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.
truecomputedbooleanOptionalDefault:
If false is passed, content will not be computed
trueResponses
200
OK
application/json
get/spaces/{spaceId}/change-requests/{changeRequestId}/content/pages
GET /v1/spaces/{spaceId}/change-requests/{changeRequestId}/content/pages HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"pages": [
{
"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",
"tagTitle": "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,
"anchors": 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?