Get OneNote content and structure with the OneNote API

Page

Page collection

    ../pages[?filter,orderby,select,top,skip,expand,count,search]

    ../sections/{section-id}/pages[?filter,orderby,select,top,skip,expand,count,search]

Page object

    ../pages/{page-id}[?select,expand]

Page HTML content

    ../pages/{page-id}/content[?includeIDs=true]
      (learn more about returned HTML content)

Section

Section collection

    ../sections[?filter,orderby,select,top,skip,expand,count]

    ../sectiongroups/{sectiongroup-id}/sections[?filter,orderby,select,top,skip,expand,count]

    ../notebooks/{notebook-id}/sections[?filter,orderby,select,top,skip,expand,count]

Section object

    ../sections/{section-id}[?select,expand]

SectionGroup

SectionGroup collection

    ../sectiongroups[?filter,orderby,select,top,skip,expand,count]

    ../notebooks/{notebook-id}/sectiongroups[?filter,orderby,select,top,skip,expand,count]

SectionGroup object

    ../sectiongroups/{sectiongroup-id}[?select,expand]

Notebook

Notebook collection

    ../notebooks[?filter,orderby,select,top,skip,expand,count]

Notebook object

    ../notebooks/{notebook-id}[?select,expand]

Resources

Image resource

    ../resources/{image-id}/$value

File resource

    ../resources/{file-id}/$value

The endpoints that link to resources are returned in the page's output HTML. An img tag includes endpoints for original and optimized image resources in the data-fullres-src and src attributes. An object tag includes the endpoint for the file resource in the data attribute.

count

count=true

The count of entities in the collection. The value is returned in the @odata.count property in the response.

expand

expand=sections,sectionGroups

The navigation properties to return inline in the response. The following properties are supported for expand expressions:

• Pages: parentNotebook, parentSection

• Sections: parentNotebook, parentSectionGroup

• Section groups: sections, sectionGroups, parentNotebook, parentSectionGroup

• Notebooks: sections, sectionGroups

By default, GET requests for pages expands parentSection and select the section's id, name, and self properties. Default GET requests for sections and section groups expand both parentNotebook and parentSectionGroup, and select the parents' id, name, and self properties.

Can be used for a single entity or a collection. Separate multiple properties with commas. Property names are case sensitive.

filter

filter=isDefault eq true

A Boolean expression for whether to include an entry in the result set.

Supports the following OData operators and functions:

• Comparison operators: eq, ne, gt, ge, lt, le

• Logical operators: and, or, not

• String functions: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat

See Supported OData operators and functions for examples.

Property names and OData string comparisons are case sensitive. We recommend using the OData tolower function for string comparisons. Example: filter=tolower(name) eq 'spring'

orderby

orderby=title,createdTime desc

The properties to sort by, with an optional asc (default) or desc sort order. You can sort by any property of the entity in the requested collection.

The default sort order for notebooks, section groups, and sections is name asc, and for pages is lastModifiedTime desc (last modified page first).

Separate multiple properties with commas, and list them in the order that you want them applied. Property names are case sensitive.

search

search=cell div

The term or phrase to search for in the page title, page body, image alt text, and image OCR text. By default, search queries return results sorted by relevance.

OneNote uses Bing full text search to support phrase search, stemming, spelling forgiveness, relevance and ranking, word breaking, multiple languages, and other full-text search features. Search strings are case insensitive.

Applies only to pages in notebooks owned by the user (not shared with the user). Indexed content is private and can only be accessed by the owner. Password-protected pages are not indexed. Applies only to the pages endpoint.

select

select=id,title

The properties to return.

Can be used for a single entity or for a collection. Separate multiple properties with commas. Property names are case sensitive.

skip

skip=10

The number of entries to skip in the result set. Typically used for paging results.

top

top=50

The number of entries to return in the result set, up to a maximum of 100. The default value for pages is 20.