MS SharePoint – Pages – Get Page

Retrieves one modern site page by its page ID. Expand can request supported relationships such as canvasLayout. The result contains mapped page metadata and optional layout data rather than a rendered browser page.

Action details

Property	Value
Action label	MS SharePoint – Pages – Get Page
Category	CloudTools
Apex class and method	GetSharePointSitePage.getPage
Input type	GetSharePointSitePage.GetSharePointSitePageInput
Output type	List<SharePointSitePage>
Authorization	OAuth Delegated (Authorization Code) or OAuth Application (Client Credentials), subject to endpoint restrictions.
Microsoft Graph request	GET /v1.0/sites/{siteId}/pages/{pageId}/microsoft.graph.sitePage

Prerequisites and permissions

Configure a CloudTools Connector with Connector Type set to Microsoft 365. Complete user sign-in for delegated access. For supported application access, grant application permissions and administrator consent. The calling identity must have access to the relevant site, list, library, or item; tenant policy and resource configuration still apply.

The action permission provider declares the following permission alternatives. These are not cumulative requirements and not all are least privileged. Check the linked Microsoft reference for the endpoint, authorization type, and current restrictions.

Permission type	Declared alternatives
Delegated	Sites.Read.All, Sites.ReadWrite.All
Application	Sites.Read.All, Sites.ReadWrite.All

See the Microsoft operation and permissions reference.

Inputs

Supply one non-null request with nonblank required identifiers. IDs must belong to the indicated site, list, or drive; do not substitute Salesforce IDs or browser URLs.

Input	Apex field	Type	Required	Description
Site Id	siteId	String	Yes	SharePoint site identifier.
Page Id	pageId	String	Yes	SharePoint page identifier.
Select	selectQuery	String	No	Comma-separated properties to return. Supply the OData value only, without a query parameter name or full URL. Microsoft validates supported values.
Expand	expandQuery	String	No	Comma-separated related resources to expand (for example canvasLayout). Supply the OData value only, without a query parameter name or full URL. Microsoft validates supported values.

The global invocable input does not expose connectorId. Direct subscriber Apex and Flow calls use CloudTools connector selection. Resolve dynamic values before invocation; this action does not resolve replacement tokens.

Outputs

Returns one SharePointSitePage inside a list, or an empty list if no response is mapped. Check for an empty result before reading fields.

Output	Apex field	Type	Description
Id	id	String	Unique identifier for the page.
Name	name	String	Page name.
Title	title	String	Page title.
Description	description	String	Page description.
Web URL	webUrl	String	Web URL of the page.
Created Date Time	createdDateTime	String	Created date and time for the page.
Last Modified Date Time	lastModifiedDateTime	String	Last modified date and time for the page.
Page Layout	pageLayout	String	Layout type for the page.
Promotion Kind	promotionKind	String	Promotion kind for the page.
Thumbnail Web URL	thumbnailWebUrl	String	Thumbnail URL for the page.
Publishing State	publishingState	SharePointPublishingState	Publishing state for the page.
Created By User	createdByUser	SharePointIdentitySet	User identity that created the page.
Last Modified By User	lastModifiedByUser	SharePointIdentitySet	User identity that last modified the page.
Parent Reference	parentReference	SharePointParentReference	Parent site/list reference for the page.
OData Type	odataType	String	OData type for the page.
OData ETag	odataEtag	String	OData ETag for the page.
Additional Properties	additionalProperties	List<DynamicObject>	Additional properties from user-defined query.

Layout and title-area properties are mapped into their model types only when returned. Request supported expansions where needed; this is metadata, not rendered HTML.

Use in Flow

Add MS SharePoint – Pages – Get Page in Flow Builder. Use a Microsoft 365 application connector configured as Set as default for Flow automations, supply the required resource IDs, and add fault handling. Delegated connections are not supported for CloudTools Flow automation. This implementation processes only the first input request and is not a bulk operation.

Use in custom Apex

This subscriber-org example uses the Apptigent namespace. Replace the identifiers, configure the connector, and run in a context that permits callouts. Arrange authorization before calling and handle exceptions in the caller.

Apptigent.GetSharePointSitePage.GetSharePointSitePageInput request =
    new Apptigent.GetSharePointSitePage.GetSharePointSitePageInput();
request.siteId = 'REPLACE_WITH_SITE_ID';
request.pageId = 'REPLACE_WITH_PAGE_ID';

List<Apptigent.SharePointSitePage> results =
    Apptigent.GetSharePointSitePage.getPage(
        new List<Apptigent.GetSharePointSitePage.GetSharePointSitePageInput>{ request }
    );

Apptigent.SharePointSitePage item = results.isEmpty() ? null : results[0];
System.debug(item == null ? null : item.id);

Use in a Lightning Web Component

Use getSharePointSitePage from msSharePointConnectorLib, through MSSharePointConnectorController. These c/ imports apply to an LWC in the same namespace. The function accepts one request object, including connectorId when applicable.

Set request.connectorId to select a configured Connector record. The controller passes this request selection through SharePointAction. The field belongs to the controller request, not the global invocable input type.

sharePointActionExample.js

import { LightningElement } from 'lwc';
import { getSharePointSitePage, MSSharePointObjects } from 'c/msSharePointConnectorLib';

export default class SharePointActionExample extends LightningElement {
    connectorId = 'REPLACE_WITH_CONNECTOR_RECORD_ID';
    result = null;
    errorMessage = '';
    isRunning = false;
    completed = false;

    async handleRun() {
        if (this.isRunning) {
            return;
        }
        this.isRunning = true;
        this.errorMessage = '';
        try {
            const request = MSSharePointObjects.inputs.site();
            request.connectorId = this.connectorId;
            request.siteId = 'REPLACE_WITH_SITE_ID';
            request.pageId = 'REPLACE_WITH_PAGE_ID';
            const result = await getSharePointSitePage(request);
            if (!result?.id) {
                throw new Error('The action did not return a usable result.');
            }
            this.result = result;
            this.completed = true;
        } catch (error) {
            this.errorMessage = error.requiresInteractiveAuthorization
                ? 'Sign in to Microsoft for the connector, then try again.'
                : error.message || 'The SharePoint action failed.';
        } finally {
            this.isRunning = false;
        }
    }
}

sharePointActionExample.html

<template>
    <lightning-button label="Run action" onclick={handleRun}
        disabled={isRunning}></lightning-button>
    <p role="alert">{errorMessage}</p>
</template>

The library resolves to one mapped resource object or null.

LWC rawJson serializes the mapped Apex object; it is not the untouched Microsoft response or an additional global invocable output. Use getMSSharePointAuthorizationState, beginMSSharePointAuthorization, and createMSSharePointOAuthMessageHandler to arrange delegated sign-in. The library normalizes controller errors, including requiresInteractiveAuthorization when available; it does not automatically sign in or retry.

Error handling and troubleshooting

Symptom	What to check
Required fields error	Supply a nonempty request list, a non-null first request, and the required identifiers or body values.
Authorization or access denied	Check connector selection, sign-in, application versus delegated permissions, administrator consent, and resource access.
Resource not found	Verify the parent site, list, and drive IDs. Distinguish list item IDs from drive item IDs and retain permission or version IDs with their resource.
Missing fields or items	Check query inputs, first-page behavior, supported expansions, item type, and mapped output limitations.
Unexpected connector	Review the connector selection behavior described above and the Microsoft 365 default connector.
Operation rejected	Inspect the Microsoft error, JSON field values, library or page state, supported API capabilities, and tenant policies.