list()

Lists the pages that the calling app manages, such as the pages from your app's site page extensions.

Each returned page exposes getPageId(), which returns the page's stable ID. The ID stays the same across page renames, so it's the identifier to persist if you need to refer back to a specific page.

Note: This method is available for site page extensions. It's not available from a site widget or plugin's settings panel. It rejects there with an internal host error. See the Pages API introduction for details.

Syntax

Copy

Parameters

This method doesn't take any parameters.

Returns

Promise<IReadOnlyPage[]>

The pages managed by the calling app. Each IReadOnlyPage exposes:

MethodTypeDescription
getPageId()Promise<string | undefined>The page's stable ID.
getTitle()Promise<string>The page's title.
getSlug()Promise<string>The page's URL slug.
getExtensionId()Promise<string | undefined>The page extension's ID, if the page is a page extension.
equals(other)booleanWhether other refers to the same page.

Example

Copy

Last updated: 25 August 2026

Did this help?