title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
List notebooks |
Retrieve a list of notebook objects. |
jewan-microsoft |
high |
onenote |
apiPageType |
Namespace: microsoft.graph
Retrieve a list of notebook objects.
[!INCLUDE national-cloud-support]
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]
GET /me/onenote/notebooks
GET /users/{id | userPrincipalName}/onenote/notebooks
GET /groups/{id}/onenote/notebooks
GET /sites/{id}/onenote/notebooks
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
.
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. |
Accept | string | application/json |
Don't supply a request body for this method.
If successful, this method returns a 200 OK
response code and collection of notebook objects in the response body.
The following example shows a request.
GET https://graph.microsoft.com/v1.0/me/onenote/notebooks
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response. Note: The response object shown here's truncated for brevity. All of the properties are returned from an actual call.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"isDefault": true,
"userRole": "Owner",
"isShared": false,
"sectionsUrl": "https://graph.microsoft.com/v1.0/users/7d54cb02-aaa3-4016-9f9c-a4b49422dd9b/onenote/notebooks/1-10143016-70dc-4449-b92a-3015225f800d/sections",
"sectionGroupsUrl": "https://graph.microsoft.com/v1.0/users/7d54cb02-aaa3-4016-9f9c-a4b49422dd9b/onenote/notebooks/1-10143016-70dc-4449-b92a-3015225f800d/sectionGroups",
"links": {
"oneNoteClientUrl": {
"href": "onenote:https://contoso-my.sharepoint.com/personal/admin_m365x841051_onmicrosoft_com/Documents/Notebooks/My%20Private%20notebook"
},
"oneNoteWebUrl": {
"href": "https://contoso-my.sharepoint.com/personal/admin_m365x841051_onmicrosoft_com/Documents/Notebooks/My%20Private%20notebook"
}
}
}
]
}