Skip to content

Latest commit

 

History

History
100 lines (84 loc) · 3.36 KB

onenote-list-pages.md

File metadata and controls

100 lines (84 loc) · 3.36 KB
Raw
title description author ms.localizationpriority ms.subservice doc_type
List pages
Retrieve a list of page objects.
jewan-microsoft
medium
onenote
apiPageType

List pages

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

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.
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 onenotePage objects in the response body.

Example

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/me/onenote/pages
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",
      "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"
    }
  ]
}