Get Doc pages

Nothing Found

Help Center
API Feature Requests

Nothing Found

Get Doc pages

View pages belonging to a Doc.

SecurityAuthorization Token

Request

path Parameters

workspaceId required	number The ID of the Workspace.
docId required	string The ID of the Doc.

query Parameters

max_page_depth	number Default: "-1" The maximum depth to retrieve pages and subpages. A value less than 0 does not limit the depth.
content_format	string Default: "text/md" The format to return the page content in. For example, `text/md` for markdown or `text/plain` for plain.

Responses

200

Pages found

get/v3/workspaces/{workspaceId}/docs/{docId}/pages

Request samples

Response samples

application/json

[{"id": "string",
"doc_id": "string",
"parent_page_id": "string",
"workspace_id": 0,
"name": "string",
"pages": [{ }
],
"sub_title": "string",
"date_created": 0,
"date_updated": 0,
"content": "string",
"avatar": {"color": "string",
"value": "string",
"source": "string"
},
"creator_id": 0,
"deleted": true,
"deleted_by": 0,
"date_deleted": 0,
"date_edited": 0,
"edited_by": 0,
"archived": true,
"archived_by": 0,
"date_archived": 0,
"authors": [0
],
"contributors": [0
],
"cover": {"color": "string",
"image_url": "string",
"position": {"x": 0,
"y": 0
}
},
"protected": true,
"protected_by": 0,
"protected_note": "string",
"presentation_details": {"font": "string",
"font_size": 0,
"line_height": 0,
"page_width": 0,
"paragraph_spacing": 0,
"show_author_header": true,
"show_contributor_header": true,
"show_cover_header": true,
"show_date_header": true,
"show_page_outline": true,
"show_sub_pages": true,
"sub_page_size": "string",
"show_sub_title_header": true,
"show_title_icon_header": true,
"show_relationships": true,
"show_relationships_compact": true,
"show_sub_pages_author": true,
"show_sub_pages_thumbnail": true,
"show_sub_pages_compact": true,
"sub_pages_style": "string"
}
}
]

© 2022 ClickUp
Security
Your Privacy
Terms