OneNote GET notebooks/id

Gets details of a specified notebook.

Last modified: June 25, 2014

Applies to: apps for SharePoint | OneNote service | SharePoint Server 2013

In this article
Resource URL
HTTP Request Headers
OAuth scopes
Extended description
Example request
HTTP response headers
Response properties
Example response
Additional resources

The GET verb with the notebooks/id resource path represents a specific notebook that is stored in Microsoft OneDrive. This includes notebooks that are both owned by and shared with the user.

Resource URL

HTML

HTTPS://www.onenote.com/api/v1.0/notebooks/{notebook ID}

Resource information

Protocol	SSL/TLS HTTPS
Response format	JSON

HTTP Request Headers

All requests to the OneNote API must include the Authorization header.

Request Header	Value and Description
Authorization	Bearer tokenString A valid OAuth token provided to the app based on the user credentials and the user having authorized access. For more information, see Authenticate the user for the OneNote API.

Security Note
The Microsoft OneNote API requires OAUTH authentication, so user names and passwords passed in clear text, as is done with Basic authentication, are not accepted. To ensure the security of your user's account credentials, be sure your app doesn't attempt to use Basic authentication, or send account credentials, even when it's over HTTPS.

OAuth scopes

Request one of the following scopes when your product authenticates the user, depending on what you want the user to be able to see.

Scopes

Scope	Purpose
office.onenote	Grants read permissions to the user's notebooks and pages. Request this scope if your product needs to query notebooks in any of the user's notebooks.
office.onenote_update_by_app	Grants create, read, update, and delete permissions to pages created by the product. Request this scope if your product only needs to query notebooks that the user created through your product.
office.onenote_update	Grants full access to the user's notebooks and pages. Request this scope if your product needs to query and update any of the user's notebooks.
office.onenote_create	Allows your product to enumerate the notebook hierarchy and create pages in any location. Request this scope if your product needs to create pages in any of the user's notebooks.

Extended description

When you use the GET verb with the /notebooks/id endpoint, the OneNote API returns the notebook as a JSON objects that conforms to the OData version 4.0 specification.

Example request

[GET] https://www.onenote.com/api/v1.0/notebooks/{notebook ID}

This returns the specified notebook, if the user has access to it. You can get a list of notebooks by using the notebooks resource path. If the user or your application doesn’t have correct permissions to get access to the notebook, the OneNote API will return an error code in the 40001-49999 range.

HTTP response headers

Response Header	Value and Description
Content-Type	Application/json: charset=utf-8 The API always returns data in JSON format.
X-CorrelationId	<GUID> The correlation ID uniquely identifies the request and can be used when debugging problems.

Response Header

Value and Description

Content-Type

Application/json: charset=utf-8

The API always returns data in JSON format.

X-CorrelationId

<GUID>

The correlation ID uniquely identifies the request and can be used when debugging problems.

Response properties

Property	Value and description	Value type
isDefault	Indicates whether this is the user’s default section.	Boolean
userRole	One of three values: Owner, Contributor, or Reader. If the value is Owner, the user has owner-level access to the notebook. If the value is Contributor, the user has read/write access to the notebook. If the value is Reader, the user has read-only access to the notebook.	string
isShared	Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner.	Boolean
sectionsUrl	The /sections endpoint where you can get details for all the sections in the notebook.	string
sectionGroupsUrl	The /sectiongroups endpoint where you can get details for all the section groups in the notebook.	string
links	The value of oneNoteClientURL can be used to open the notebook using the OneNote native client app if it's installed. The value of oneNoteWebURL can be used to open the web-browser based OneNote Online client.	links object
self	The endpoint where you can get details about the notebook.	string
id	The unique identifier of the notebook.	string
name	The name of the notebook.	string
createdBy	The user who created the notebook.	string
createdTime	The date and time when the notebook was created.	An ISO 8601 formatted date.
lastModifiedBy	The user who last modified the notebook.	string
lastModifiedTime	The date and time when the notebook was last modified.	An ISO 8601 formatted date.

Example response

JSON

Content-Type: application/json
X-CorrelationId: <GUID>
Status: 200 OK
{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#notebooks","value":[
    {
      "isDefault":false,
"userRole":"Contributor",
"isShared":true,
"sectionsUrl":"https://www.onenote.com/api/v1.0/notebooks/notebook ID/sections",
"sectionGroupsUrl":"https://www.onenote.com/api/v1.0/notebooks/notebook ID/sectionGroups",
"links":{
        "oneNoteClientUrl":{
          "href":"https:{client URL}"
        },"oneNoteWebUrl":{
          "href":"https://{web URL}"
        }
      },
"id":"notebook ID",
"name":"notebook name",
"self":"https://www.onenote.com/api/v1.0/notebooks/notebook ID",
"createdBy":"user name",
"lastModifiedBy":"user name",
"createdTime":"2013-10-05T10:57:00.683Z",
"lastModifiedTime":"2014-01-28T18:49:00.47Z"
    }
  ]
}