sitepage: getWebPartsByPosition

Namespace: microsoft.graph


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 a collection of webPart by providing webPartPosition information.


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/{siteId}/pages/{sitePageId}/microsoft.graph.sitePage/getWebPartsByPosition

Function parameters

In the request URL, provide one or more following parameters with a valid value.

Parameter Type Description
columnId Double Indicate the identifier of the column where the WebPart located in. Only works if horizontalSectionId is provided.
horizontalSectionId Double Indicate the horizontal section where the WebPart located in.
isInVerticalSection boolean Indicate whether the WebPart located in the vertical section.
webPartIndex Double Index of the current WebPart. Represents the order of WebPart in this column or section. Only works if either columnId or isInVerticalSection is provided.

Optional query parameters

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

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

Don't supply a request body for this method.


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



The following is an example of a request.



The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

  "value": [
      "@odata.type": "#microsoft.graph.textWebPart",
      "id": "d79d70af-27ea-4208-8dce-23c3bf678664",
      "innerHtml": "<h2>How do you get started?</h2>"