List notebooks

Retrieve a list of notebook objects.

Prerequisites

One of the following scopes is required to execute this API:

Notes.Create, Notes.Read, Notes.ReadWrite, Notes.Read.All, or Notes.ReadWrite.All

HTTP request

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

Optional query parameters

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

The default sort order is name asc.

Valid expand values for notebooks are sections and sectionGroups.

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 collection of notebook objects in the response body.

Example

Request

Here is an example of the request.

GET https://graph.microsoft.com/v1.0/me/onenote/notebooks
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: 369

{
  "value": [
    {
      "isDefault": true,
      "userRole": {
      },
      "isShared": true,
      "sectionsUrl": "sectionsUrl-value",
      "sectionGroupsUrl": "sectionGroupsUrl-value",
      "links": {
        "oneNoteClientUrl": {
          "href": "href-value"
        },
        "oneNoteWebUrl": {
          "href": "href-value"
        }
      }
    }
  ]
}