OneNote GET notebooks

Protocol

SSL/TLS HTTPS

Response format

JSON

$orderby

One or more comma-delimited expressions with an optional ‘asc’ (the default) or ‘desc’ depending on the order you’d like the values sorted. The value of this operator is the list of notebook properties to use for sorting the notebooks returned by the API and the order in which to sort the results. Valid properties are lastModifiedTime, createdTime, and name. These values are case-sensitive. The default value is name asc (ascending by name). The modifiedTime property refers to the date and time when a page in the section was last modified. You can specify a list of properties, such as $orderby=name asc, lastModifiedTime desc (ascending by name and descending by lastModifiedTime). The order in which you list the properties will determine the level at which each sort occurs. If you specify a property more than once, only the first instance of the property will be used.

$orderby=name asc

$filter

A Boolean expression for whether a particular entry should be included in the response.

$filter=contains(name, ‘text’)

$select

Limit the properties on each entry in the response to the ones that are specified by this value.

$select=id,name

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.

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.

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.

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.