Get page

Namespace: microsoft.graph

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.

This API is supported in the following national cloud deployments.

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

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

Don't supply a request body for this method.

Response

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

Example

Request

Here's an example of the request.

HTTP

GET https://graph.microsoft.com/v1.0/me/onenote/pages/{id}

C#

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

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Me.Onenote.Pages["{onenotePage-id}"].GetAsync();

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 users onenote pages get --user-id {user-id} --onenote-page-id {onenotePage-id}

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-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



pages, err := graphClient.Me().Onenote().Pages().ByOnenotePageId("onenotePage-id").Get(context.Background(), nil)

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

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

OnenotePage onenotePage = graphClient.me().onenote().pages("{id}")
	.buildRequest()
	.get();

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 onenotePage = await client.api('/me/onenote/pages/{id}')
	.get();

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

PHP

<?php

// THIS SNIPPET IS A PREVIEW VERSION OF THE SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->onenote()->pages()->byOnenotePageId('onenotePage-id')->get()->wait();

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.Notes

# A UPN can also be used as -UserId.
Get-MgUserOnenotePage -UserId $userId -OnenotePageId $onenotePageId

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

Python

# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(request_adapter)


result = await graph_client.me.onenote.pages.by_page_id('onenotePage-id').get()

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

Response

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

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

{
  "title": "title-value",
  "createdByAppId": "createdByAppId-value",
  "links": {
    "oneNoteClientUrl": {
      "href": "href-value"
    },
    "oneNoteWebUrl": {
      "href": "href-value"
    }
  },
  "contentUrl": "contentUrl-value",
  "content": "content-value",
  "lastModifiedDateTime": "2016-10-19T10:37:00Z"
}