page.getUtilityPageKey()

Get the page key of a Webflow utility page.

Syntax

page.getUtilityPageKey(): Promise<null | UtilKey>

Returns

Promise<null | UtilKey>

A promise that resolves to one of the following utility page keys, or null if the page is not a utility page:

• '401' - Unauthorized access page
• '404' - Not found page
• 'search' - Search results page
• 'ecommerce-checkout' - Main checkout page
• 'ecommerce-paypal-checkout' - PayPal checkout flow
• 'ecommerce-confirmation' - Order confirmation page
• 'usys-log-in' - User login page
• 'usys-sign-up' - User registration page
• 'usys-reset-password' - Password reset request page
• 'usys-user-account' - User account management
• 'usys-update-password' - Password update page
• 'usys-access-denied' - Access denied error page

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage() as Page
// Get utility page key
const utilityKey = await currentPage.getUtilityPageKey()
console.log("Utility Key", utilityKey)

Designer Ability