List SitePage
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 sitePage objects from the site pages list in a site site. All pages in the site are returned (with pagination). Sort alphabetically by name
in ascending order.
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/microsoft.graph.sitePage
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
and a list of sitePage object in the response body.
Example
Request
GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/microsoft.graph.sitePage
Response
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "08f48aa6-02e3-407c-bbcb-ff61cec653fa",
"name": "sample.aspx",
"webUrl": "https://contoso.sharepoint.com/SitePages/sample.aspx",
"title": "sample",
"pageLayout": "article",
"showComments": true,
"showRecommendedPages": false,
"createdBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"lastModifiedBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"publishingState": {
"level": "checkout",
"versionId": "1.1",
"checkedOutBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
}
},
"reactions": {
"commentCount": 4,
"likeCount": 2
},
"titleArea": {
"enableGradientEffect": true,
"imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg",
"layout": "imageAndTitle",
"showAuthor": false,
"showPublishedDate": false,
"showTextBlockAboveTitle": false,
"textAboveTitle": "",
"textAlignment": "left",
"imageSourceType": 2,
"title": "sample"
}
},
{
"id": "7d87eee1-7c77-46b5-b2c4-ad6e4e432a8e",
"name": "Home.aspx",
"webUrl": "https://contoso.sharepoint.com/SitePages/Home.aspx",
"title": "Home",
"pageLayout": "home",
"showComments": true,
"showRecommendedPages": false,
"createdBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"lastModifiedBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"publishingState": {
"level": "checkout",
"versionId": "1.1",
"checkedOutBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
}
},
"reactions": {
"commentCount": 1
},
"titleArea": {
"enableGradientEffect": true,
"imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg",
"layout": "imageAndTitle",
"showAuthor": true,
"showPublishedDate": false,
"showTextBlockAboveTitle": false,
"textAboveTitle": "Text Above Title",
"textAlignment": "left",
"imageSourceType": 2,
"title": "Home",
"hasTitleBeenCommitted": true
}
}
]
}