List baseSitePages

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get the collection of baseSitePage objects from the site pages list in a site. All pages in the site are returned (with pagination). Sort alphabetically by name in ascending order.

Note: The baseSitePage specified is a parent type and does not have any instance. As a result, the returned data only consists of available subtypes that are provided as a list.

The following table lists the available subtypes.

Entity name	Description
sitePage	Represents a regular page.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Sites.Read.All	Sites.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Sites.Read.All	Sites.ReadWrite.All

HTTP request

GET /sites/{site-id}/pages

Optional query parameters

This method supports the $count, $expand, $filter, $orderby, $select, and $top OData query parameters to help customize the response.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of baseSitePage objects in the response body.

Example

Request

The following example shows a request.

HTTP

GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Sites["{site-id}"].Pages.GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta sites pages list --site-id {site-id}

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



pages, err := graphClient.Sites().BySiteId("site-id").Pages().Get(context.Background(), nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

BaseSitePageCollectionResponse result = graphClient.sites().bySiteId("{site-id}").pages().get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let pages = await client.api('/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages')
	.version('beta')
	.get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->sites()->bySiteId('site-id')->pages()->get()->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Beta.Sites

Get-MgBetaSitePage -SiteId $siteId

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.sites.by_site_id('site-id').pages.get()

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.sitePage",
      "@odata.etag": "\"{5FA48F95-2FDF-40E8-A28C-6D0D8345BCD2},8\"",
      "description": "Placeat porro perspiciatis maxime esse nobis illo.Voluptate vitae maxime totam consectetur fugit sit quos.Saepe ea veniam voluptate tempore quod deleniti necessitatibus repellat.",
      "eTag": "\"{5FA48F95-2FDF-40E8-A28C-6D0D8345BCD2},8\"",
      "id": "5fa48f95-2fdf-40e8-a28c-6d0d8345bcd2",
      "lastModifiedDateTime": "2023-04-16T08:37:51Z",
      "name": "Account holistic.aspx",
      "webUrl": "https://contoso.sharepoint.com/SitePages/Account holistic.aspx",
      "title": "CSS Global Lithuanian meter",
      "pageLayout": "article",
      "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/a830edad9050849vanaukyisx52.spgrid.com/_layouts/15/images/sitepagethumbnail.png",
      "promotionKind": "page",
      "showComments": false,
      "showRecommendedPages": false,
      "contentType": {
        "id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A",
        "name": "Site Page"
      },
      "createdBy": {
        "user": {
          "displayName": "admin_contoso",
          "email": "admin@contoso.com"
        }
      },
      "lastModifiedBy": {
        "user": {
          "displayName": "admin_contoso",
          "email": "admin@contoso.com"
        }
      },
      "parentReference": {
        "siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3"
      },
      "publishingState": {
        "level": "draft",
        "versionId": "0.4"
      },
      "reactions": {}
    },
    {
      "@odata.type": "#microsoft.graph.sitePage",
      "@odata.etag": "\"{DA0F67BE-977E-4D09-88AC-506A1002E678},5\"",
      "eTag": "\"{DA0F67BE-977E-4D09-88AC-506A1002E678},5\"",
      "id": "da0f67be-977e-4d09-88ac-506a1002e678",
      "lastModifiedDateTime": "2023-04-16T06:39:30Z",
      "name": "Analyst Fresh.aspx",
      "webUrl": "https://contoso.sharepoint.com/SitePages/Analyst Fresh.aspx",
      "title": "Lesotho Account Metal Analyst du",
      "pageLayout": "article",
      "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/a830edad9050849vanaukyisx52.spgrid.com/_layouts/15/images/sitepagethumbnail.png",
      "promotionKind": "page",
      "showComments": false,
      "showRecommendedPages": false,
      "contentType": {
        "id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A",
        "name": "Site Page"
      },
      "createdBy": {
        "user": {
          "displayName": "admin_contoso",
          "email": "admin@contoso.com"
        }
      },
      "lastModifiedBy": {
        "user": {
          "displayName": "admin_contoso",
          "email": "admin@contoso.com"
        }
      },
      "parentReference": {
        "siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3"
      },
      "publishingState": {
        "level": "draft",
        "versionId": "0.1"
      },
      "reactions": {},
      "titleArea": {
        "enableGradientEffect": false,
        "imageWebUrl": "https://loremflickr.com/640/480",
        "layout": "plain",
        "showAuthor": false,
        "showPublishedDate": false,
        "showTextBlockAboveTitle": false,
        "textAboveTitle": "generating ADP",
        "textAlignment": "center",
        "title": "strategic underneath protocol Buckinghamshire forecast",
        "authors@odata.type": "#Collection(String)",
        "authors": [],
        "authorByline@odata.type": "#Collection(String)",
        "authorByline": [],
        "imageSourceType": 4,
        "serverProcessedContent": {
          "htmlStrings": [],
          "searchablePlainTexts": [],
          "links": [],
          "imageSources": []
        }
      }
    }
  ]
}