This endpoint retrieves a list of all pages contained within a specified workbook. It is useful for applications needing to display an overview or navigate through different pages of a workbook.

Usage notes

• Retrieve the workbookId by calling the /v2/workbooks endpoint.
• To retrieve pages from version-tagged workbooks, pass the tag in the query parameters with the tag name. Retrieve the tag name by calling the /v2/workbooks endpoint and using the tags.name included in the response for a given workbook.
• To retrieve pages from a bookmark (saved view), pass the bookmarkId in the query parameters. Retrieve the bookmarkId by calling the /v2/workbooks/{workbookId}/bookmarks or /v2/workbooks/{workbookId}/tags/:tagName/bookmarks endpoints.

Usage scenarios

• Navigation: Helps users and applications navigate through different pages of a workbook efficiently.
• Content Discovery: Allows users to quickly view and access the variety of pages contained within a workbook.

Best practices

• Always name pages to make it easy for users to navigate.
• Utilize pagination to manage and streamline the retrieval of large numbers of pages.
• Ensure that users or systems querying this endpoint have appropriate permissions to access the workbook's content.