notebook: getRecentNotebooks

  • 2 minutes to read

Get a list of recentNotebook instances that have been accessed by the signed-in user.

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.Create, Notes.Read, Notes.ReadWrite, Notes.Read.All, Notes.ReadWrite.All
Delegated (personal Microsoft account) Notes.Create, Notes.Read, Notes.ReadWrite
Application Notes.Read.All, Notes.ReadWrite.All

HTTP request

GET /me/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks=includePersonalNotebooks-value)
GET /users/{id | userPrincipalName}/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks=includePersonalNotebooks-value)

The {id | userPrincipalName} for the user must match the user encoded in the authorization token used to make the request.

Function parameters

Parameter Type Description
includePersonalNotebooks Boolean Include notebooks owned by the user. Set to true to include notebooks owned by the user; otherwise, set to false. If you don't include the includePersonalNotebooks parameter, your request will return a 400 error response.

Request headers

Name Description
Authorization Bearer {code}

Request body

Do not supply a request body for this method.

Response

A successful response returns a 200 OK that contains a JSON collection of recentNotebooks.

Example

The following example shows how to call this API.

Request

The following example shows the request.

GET https://graph.microsoft.com/v1.0/me/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks=true)

Response

The following example shows the response.

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

{
  "value":[
    {
      "displayName":"Personal Notebook","lastAccessedTime":"timestamp","links":{
        "oneNoteClientUrl":{
          "href":"onenote:href-value"
        },"oneNoteWebUrl":{
          "href":"href-value"
        }
      },"sourceService":"OneDrive"
    },{
      "displayName":"Team Shared Notebook","lastAccessedTime":"timestamp","links":{
        "oneNoteClientUrl":{
          "href":"onenote:href-value"
        },"oneNoteWebUrl":{
          "href":"href-value"
        }
      },"sourceService":"OneDriveForBusiness"
    }
  ]
}