Get page

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

Retrieve the properties and relationships of a page object.

Getting page information

Access a page's metadata by page identifier:

GET /me/onenote/pages/{id}

Getting page content

You can use the page's content endpoint to get the HTML content of a page:

GET /me/onenote/pages/{id}/content[?includeIDs=true]
GET /me/onenote/pages/{id}/$value[?includeIDs=true]

The includeIDs=true query option is used to update pages.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Notes.Read, Notes.ReadWrite, Notes.Read.All, Notes.ReadWrite.All
Delegated (personal Microsoft account) Notes.Read, Notes.ReadWrite
Application Notes.Read.All, Notes.ReadWrite.All

HTTP request

GET /me/onenote/pages/{id}
GET /users/{id | userPrincipalName}/onenote/pages/{id}
GET /groups/{id}/onenote/pages/{id}
GET /sites/{id}/onenote/pages/{id}

Optional query parameters

This method supports the select and expand OData Query Parameters to help customize the response.

The default response expands parentSection and selects the section's id, name, and self properties. Valid expand values for pages are parentNotebook and parentSection.

Request headers

Name Type Description
Authorization string Bearer {token}. Required.
Accept string application/json

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and the onenotePage object in the response body.

Example

Request

Here is an example of the request.

GET https://graph.microsoft.com/beta/me/onenote/pages/{id}
Response

Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "title": "title-value",
  "createdByAppId": "createdByAppId-value",
  "id": "8fcb5dbc-d5aa-4681-8e31-b001d5168d79",
  "links": {
    "oneNoteClientUrl": {
      "href": "href-value"
    },
    "oneNoteWebUrl": {
      "href": "href-value"
    }
  },
  "contentUrl": "contentUrl-value",
  "content": "content-value",
  "lastModifiedDateTime": "2016-10-19T10:37:00Z"
}