Get 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.
Returns the metadata for a sitePage in the site pages list in a site.
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/{page-id}/microsoft.graph.sitePage
Optional query parameters
This method supports the $select
and $expand
OData query parameters to help customize the response. For general information, see OData query parameters.
You can use the $expand=canvasLayout
query string parameter to include the content of an item when retrieving the metadata of an item if the item has a =canvasLayout relationship.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Accept | application/json;odata.metadata=none. Optional. Removes all OData metadata from the response. We recommend including this header when the response will be used in another request. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200
and a sitePage object in the response body.
Examples
Example 1: Get a page in the site pages list of a site
Request
GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage
Response
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.type": "microsoft.graph.sitePage",
"description": "Here's the page description",
"id": "65e59907-59d5-44ff-a038-7c0bf3098c01",
"name": "Home.aspx",
"webUrl": "https://contoso.sharepoint.com/SitePages/Home.aspx",
"title": "Organization Home",
"thumbnailWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/00210d24-bba0-42e6-9a31-1d452a95dd75/thumbnails/large.jpg?file=163352059.jpg",
"promotionKind": "page",
"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": "published",
"versionId": "1.0"
},
"reactions": {
"commentCount": 1
}
}
Example 2: Get a page using select and expand
Request
With $select
and $expand
statements, you can retrieve sitePage metadata and page content in a single request.
GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage?$select=id,name
Response
The following example shows the response.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.etag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"",
"id": "f45354cb-d634-45df-8b88-2b4e96a1dc45",
"name": "Electronic Convertible.aspx"
}
Example 3: Get a page with page content
Request
You can expand references in your URL with the $expand query parameter. To access the page with page content, append the ?$expand=canvasLayout
query string.
GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage?$expand=canvasLayout
Response
{
"description": "Reiciendis placeat dolores.",
"eTag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"",
"id": "f45354cb-d634-45df-8b88-2b4e96a1dc45",
"lastModifiedDateTime": "2023-04-16T10:01:41Z",
"name": "autotest Electronic Convertible.aspx",
"webUrl": "https://contoso.sharepoint.com/SitePages/autotest Electronic Convertible.aspx",
"title": "autotest Electronic Convertible",
"pageLayout": "article",
"thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/sitepagethumbnail.png",
"promotionKind": "page",
"showComments": false,
"showRecommendedPages": true,
"createdBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"lastModifiedBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"parentReference": {
"listId": "468fc883-e278-4773-ba09-91351a1e42ed",
"siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3"
},
"contentType": {
"id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A",
"name": "Site Page"
},
"publishingState": {
"level": "draft",
"versionId": "0.4"
},
"reactions": {},
"canvasLayout": {
"horizontalSections": [
{
"layout": "threeColumns",
"id": "1",
"emphasis": "neutral",
"columns": [
{
"id": "1",
"width": 4,
"webparts": [
{
"@odata.type": "#oneDrive.textWebPart",
"id": "f6d0ef70-c977-45e4-ae4b-4676a30d5aab",
"innerHtml": "<h1>sample content</h1>"
}
]
},
{
"id": "2",
"width": 4,
"webparts": [
{
"@odata.type": "#oneDrive.textWebPart",
"id": "99f59f91-c853-433e-9e75-ad7a32e46106",
"innerHtml": "<h1>sample content</h1>"
}
]
},
{
"id": "3",
"width": 4,
"webparts": [
{
"@odata.type": "#oneDrive.textWebPart",
"id": "48998492-9633-48b8-a7e9-d293533b4fa6",
"innerHtml": "<h1>sample content</h1>"
}
]
}
]
}
]
}
}