Skip to content

onenote-list-pages.md

Latest commit

 

History

History
135 lines (109 loc) · 4.88 KB

onenote-list-pages.md

File metadata and controls

135 lines (109 loc) · 4.88 KB
title List onenotePages
description Retrieve a list of page objects.
author jewan-microsoft
ms.localizationpriority medium
ms.subservice onenote
doc_type apiPageType
ms.date 06/21/2024

List onenotePages

Namespace: microsoft.graph

Retrieve a list of page objects.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

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

Optional query parameters

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

The default query for pages returns the top 20 pages ordered by lastModifiedTime desc. If the default query returns more than 20 pages, the response contains an @odata.nextLink that you can use to page through the result set. The maximum number of pages returned for a top request is 100.

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

Request headers

Name Type Description
Authorization string Bearer {token}. Required. Learn more about authentication and authorization.
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 a collection of page objects in the response body.

Example

Request

The following example shows a request.

HTTP

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

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows 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

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