Get OneNote content and structure

Makale
04/19/2024

Applies to: Consumer notebooks on OneDrive | Enterprise notebooks on Microsoft 365

To get OneNote content and structure by using the Microsoft Graph OneNote API, you send a GET request to the target endpoint. For example:

GET ../onenote/pages/{id}

If the request is successful, Microsoft Graph returns a 200 OK HTTP status code and the entities or content that you requested. OneNote entities are returned as JSON objects that conform to the OData version 4.0 specification.

By using query string options, you can filter your queries and improve performance.

Note

If you're building a solution that supports one of the following scenarios, you will reach OneNote API limitations:

Backup/restore OneNote sections
Backup/restore OneNote notebooks

For backup and restore operations, see Best practices for discovering files and detecting changes at scale.

Construct the request URI

To construct the request URI, start with the service root URL:

https://graph.microsoft.com/v1.0/me/onenote

Then append the endpoint of the resource you want to retrieve. (Resource paths are shown in the next section.)

Your full request URI will look like one of these examples:

https://graph.microsoft.com/v1.0/me/onenote/notebooks/{id}/sections
https://graph.microsoft.com/v1.0/me/onenote/notes/pages
https://graph.microsoft.com/v1.0/me/onenote/pages?select=title,self

Note

Learn more about the service root URL.

Resource paths for GET requests

Use the following resource paths to get pages, sections, section groups, notebooks, and image or file resources.

Page collection
Page entity
Page preview
Page HTML content
Section collection
Section entity
SectionGroup collection
SectionGroup entity
Notebook collection
Notebook entity
Image or other file resource

Page collection

Get pages (metadata) across all notebooks.

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

Get pages (metadata) from a specific section.

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

The default sort order for pages is lastModifiedTime desc.

The default query expands the parent section and selects the section's id, name, and self properties.

By default, only the top 20 entries are returned for GET pages requests. Requests that don't specify a top query string option return an @odata.nextLink link in the response that you can use to get the next 20 entries.

For the pages collection in a section, use pagelevel to return the indentation level of pages and their order within the section.

Example

GET ../sections/{section-id}/pages?pagelevel=true

Page entity

Get the metadata for a specific page.

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

Pages can expand the parentNotebook and parentSection properties.

The default query expands the parent section and selects the section's id, name, and self properties.

Use pagelevel to return the indentation level of the page and its order within its parent section.

Example

GET ../pages/{page-id}?pagelevel=true

Page preview

Get text and image preview content for a page.

../pages/{page-id}/preview

The JSON response contains the preview content, which you can use to help users identify what's in the page.

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Microsoft.OneNote.Api.PagePreview",
  "previewText":"text-snippet",
  "links":{
    "previewImageUrl":{
      "href":"https://www.onenote.com/api/v1.0/resources/{id}/content?publicAuth=true&mimeType=image/png"
    }
  }
}

The previewText property contains a text snippet from the page. Microsoft Graph returns complete phrases, up to a maximum of 300 characters.

If the page has an image that can be used to build a preview UI, the href property in the previewImageUrl object contains a link to a public image resource. You can use this link in HTML. Otherwise, href returns null.

Example

<img src="https://www.onenote.com/api/v1.0/resources/{id}/content?publicAuth=true&mimeType=image/png" />

Page HTML content

Get the HTML content of a page.

../pages/{page-id}/content[?includeIDs]

(learn more about returned HTML content)

Use the includeIDs=true query string option to get generated IDs used to update the page.

Section collection

Get all sections from all notebooks that are owned by the user, including sections in nested section groups.

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

Get all sections that are directly under a specific section group.

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

Get all sections that are directly under a specific notebook.

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

Sections can expand the parentNotebook and parentSectionGroup properties.

The default sort order for sections is name asc.

The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Section entity

Get a specific section.

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

Sections can expand the parentNotebook and parentSectionGroup properties.

The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

SectionGroup collection

Get all section groups from all notebooks that are owned by the user, including nested section groups.

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

Get all section groups that are directly under a specific notebook.

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

Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

The default sort order for section groups is name asc.

The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

SectionGroup entity

Get a specific section group.

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

Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

Notebook collection

Get all the notebooks that are owned by the user.

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

Notebooks can expand the sections and sectionGroups properties.

The default sort order for notebooks is name asc.

Notebook entity

Get a specific notebook.

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

Notebooks can expand the sections and sectionGroups properties.

Image or other file resource

Get the binary data of a specific resource.

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

You can find the file's resource URI in the page's output HTML.

For example, an img tag includes endpoints for the original image in the data-fullres-src attribute and the optimized image in the src attribute.

Example

<img 
    src="https://www.onenote.com/api/v1.0/me/notes/resources/{image-id}/$value"  
    data-src-type="image/png"
    data-fullres-src="https://www.onenote.com/api/v1.0/resources/{image-id}/$value"  
    data-fullres-src-type="image/png" ... />

And an object tag includes the endpoint for the file resource in the data attribute.

Example

<object
    data="https://www.onenote.com/api/v1.0/me/notes/resources/{file-id}/$value"
    data-attachment="fileName.pdf" 
    type="application/pdf" ... />

Note

Getting a collection of resources is not supported.

When you get a file resource, you don't need to include an Accept content type in the request.

For more information about GET requests, see the following resources in the Microsoft Graph API REST reference:

Example GET requests

You can query for OneNote entities to get just the information you need. The following examples show some ways you can use supported query string options in GET requests to Microsoft Graph.

Remember:

All GET requests start with the service root URL.

Examples: https://www.onenote.com/api/v1.0/me/notes and https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/
Spaces in the URL query string must use %20 encoding.

Example: filter=title%20eq%20'biology'
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'

filter

Get all pages that were created by a specific app.

[GET] ../pages?filter=createdByAppId eq 'WLID-000000004C12821A'

select

Get the title, OneNote client links, and contentUrl link for all pages.

[GET] ../pages?select=title,links,contentUrl

expand

Get all notebooks and expand their sections and section groups.

[GET] ../notebooks?expand=sections,sectionGroups

Get a specific section group and expand its sections and section groups.

[GET] ../sectionGroups/{sectiongroup-id}?expand=sections,sectionGroups

Get a page and expand its parent section and parent notebook.

[GET] ../pages/{page-id}?expand=parentSection,parentNotebook

expand (multiple levels)

Get all notebooks and expand their sections and section groups, and expand all sections in each section group.

[GET] ../notebooks?expand=sections,sectionGroups(expand=sections)

Note

Expanding parents of child entities or expanding children of parent entities creates a circular reference and is not supported.

expand & select (multiple levels)

Get the name and self link for a specific section group, and get the name and self links for all its sections.

[GET] ../sectionGroups/{sectiongroup-id}?expand=sections(select=name,self)&select=name,self

Get the name and self link for all sections, and get the name and created time of each section's parent notebook.

[GET] ../sections?expand=parentNotebook(select=name,createdTime)&select=name,self

Get the title and ID for all pages, and get the name of the parent section and parent notebook.

[GET] ../pages?select=id,title&expand=parentSection(select=name),parentNotebook(select=name)

expand & levels (multiple levels)

Get all notebooks, sections, and section groups.

[GET] ../notebooks?expand=sections,sectionGroups(expand=sections,sectionGroups(levels=max;expand=sections))

filter

Get all sections that were created in October 2014.

[GET] ../sections?filter=createdTime ge 2014-10-01 and createdTime le 2014-10-31

Get the pages that were created by a specific app since January 1, 2015.

[GET] ../pages?filter=createdByAppId eq 'WLID-0000000048118631' and createdTime ge 2015-01-01

filter & expand

Get all pages in a specific notebook. The API returns 20 entries by default.

[GET] ../pages?filter=parentNotebook/id eq '{notebook-id}'&expand=parentNotebook

Get the name and pagesUrl link for all sections from the School notebook. OData string comparisons are case-sensitive, so use the tolower function as a best practice.

[GET] ../notebooks?filter=tolower(name) eq 'school'&expand=sections(select=name,pagesUrl)

filter & select & orderby

Get the name and pagesUrl link for all sections that contain the term spring in the section name. Order sections by last modified date.

[GET] ../sections?filter=contains(tolower(name),'spring')&select=name,pagesUrl&orderby=lastModifiedTime desc

orderby

Get the first 20 pages ordered by createdByAppId property and then by most recent created time. The API returns 20 entries by default.

[GET] ../pages?orderby=createdByAppId,createdTime desc

filter & top

Get the five newest pages created since January 1, 2015. The API returns 20 entries by default with a maximum of 100. The default sort order for pages is lastModifiedTime desc.

[GET] ../pages?filter=createdTime ge 2015-01-01&top=5

filter & top & skip

Get the next five pages in the result set .

[GET] ../pages?filter=createdTime ge 2015-01-01&top=5&skip=5

And the next five.

[GET] ../pages?filter=createdTime ge 2015-01-01&top=5&skip=10

Note

If both top and filter are applied to the same request, the results include only those entities that match both criteria.

select

Get the name, created time, and self link for all sections in the user's notebooks.

[GET] ../sections?select=name,createdTime,self

Get the title, created time, and OneNote client links for a specific page.

[GET] ../pages/{page-id}?select=title,createdTime,links

select & expand & filter (multiple levels)

Get the name and pagesUrl link for all sections in the user's default notebook.

[GET] ../notebooks?select=name&expand=sections(select=name,pagesUrl)&filter=isDefault eq true

top & select & orderby

Get the title and self link for the first 50 pages, ordered alphabetically by title. The API returns 20 entries by default with a maximum of 100. The default sort order for pages is lastModifiedTime desc.

[GET] ../pages?top=50&select=title,self&orderby=title

skip & top & select & orderby

Get pages 51 to 100. The API returns 20 entries by default with a maximum of 100.

[GET] ../pages?skip=50&top=50&select=title,self&orderby=title

Note

GET requests for pages that retrieve the default number of entries (that is, they don't specify a top expression) return an @odata.nextLink link in the response that you can use to get the next 20 entries.

Supported OData query string options

When sending GET requests to Microsoft Graph, you can use OData query string options to customize your query and get just the information you need. They can also improve performance by reducing the number of calls to the service and the size of the response payload.

Note

For readability, the examples in this article don't use the %20 percent-encoding required for spaces in the URL query string: filter=isDefault%20eq%20true

Query option	Example and description
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 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.
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 is 20.

Microsoft Graph also provides the pagelevel query string option you can use to get the level and order of pages within the parent section. Applies only to queries for pages in a specific section or queries for a specific page.

Examples

GET ../sections/{section-id}/pages?pagelevel=true
GET ../pages/{page-id}?pagelevel=true

Supported OData operators and functions

Microsoft Graph supports the following OData operators and functions in filter expressions. When using OData expressions, remember:

Spaces in the URL query string must be replaced with the %20 encoding.

Example: filter=isDefault%20eq%20true
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'

Comparison operator	Example
eq (equal to)	`createdByAppId eq '{app-id}'`
ne (not equal to)	`userRole ne 'Owner'`
gt (greater than)	`createdTime gt 2014-02-23`
ge (greater than or equal to)	`lastModifiedTime ge 2014-05-05T07:00:00Z`
lt (less than)	`createdTime lt 2014-02-23`
le (less than or equal to)	`lastModifiedTime le 2014-02-23`

Logical operator	Example
and	`createdTime le 2014-01-30 and createdTime gt 2014-01-23`
or	`createdByAppId eq '{app-id}' or createdByAppId eq '{app-id}'`
not	`not contains(tolower(title),'school')`

String function	Example
contains	`contains(tolower(title),'spring')`
endswith	`endswith(tolower(title),'spring')`
startswith	`startswith(tolower(title),'spring')`
length	`length(title) eq 19`
indexof	`indexof(tolower(title),'spring') eq 1`
substring	`substring(tolower(title),1) eq 'spring'`
tolower	`tolower(title) eq 'spring'`
toupper	`toupper(title) eq 'SPRING'`
trim	`trim(tolower(title)) eq 'spring'`
concat	`concat(title,'- by MyRecipesApp') eq 'Carrot Cake Recipe - by MyRecipesApp'`

OneNote entity properties

The filter, select, expand, and orderby query expressions can include properties of OneNote entities.

Example

../sections?filter=createdTime ge 2015-01-01&select=name,pagesUrl&orderby=lastModifiedTime desc

Property names are case-sensitive in query expressions.

For the list of properties and property types, see the following resources in the Microsoft Graph API REST reference:

The expand query string option can be used with the following navigation properties:

Pages: parentNotebook, parentSection
Sections: parentNotebook, parentSectionGroup
Section groups: sections, sectionGroups, parentNotebook, parentSectionGroup
Notebooks: sections, sectionGroups

Request and response information for GET requests

Request data Description

Protocol All requests use the SSL/TLS HTTPS protocol.

Authorization header

Request data	Description
Protocol	All requests use the SSL/TLS HTTPS protocol.
Authorization header	`Bearer {token}`, where `{token}` is a valid OAuth 2.0 access token for your registered app. If missing or invalid, the request fails with a 401 status code. See Authentication and permissions.
Accept header	`application/json` for OneNote entities and entity sets `text/html` for page content

Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

If missing or invalid, the request fails with a 401 status code. See Authentication and permissions.

Accept header

application/json for OneNote entities and entity sets

text/html for page content

Response data	Description
Success code	A 200 HTTP status code.
Response body	An OData representation of the entity or entity set in JSON format, the page HTML, or file resource binary data.
Errors	If the request fails, the API returns errors in the @api.diagnostics object in the response body.
X-CorrelationId header	A GUID that uniquely identifies the request. You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Constructing the Microsoft Graph notes service root URL

The Microsoft Graph notes root URL uses the following format for all calls to Microsoft Graph notes:

https://graph.microsoft.com/{version}/me/onenote/

The version segment in the URL represents the version of Microsoft Graph that you want to use. Use v1.0 for stable production code. Use beta to try out a feature that's in development. Features and functionality in beta may change, so you shouldn't use it in your production code.

Use me for OneNote content that the current user can access (owned and shared). Use users/{id} for OneNote content that the specified user (in the URL) has shared with the current user. Use Microsoft Graph to get user IDs.

Permissions for GET requests

To get OneNote content or structure, you'll need to request appropriate permissions.

The following scopes allow GET requests to Microsoft Graph. Choose the lowest level of permissions that your app needs to do its work.

Choose from:

Notes.read
Notes.ReadWrite
Notes.ReadWrite.All

For more information about permission scopes and how they work, see Microsoft Graph permissions reference.

Aracılığıyla paylaş

Get OneNote content and structure

Construct the request URI

Resource paths for GET requests

Page collection

Example

Page entity

Example

Page preview

Example

Page HTML content

Section collection

Section entity

SectionGroup collection

SectionGroup entity

Notebook collection

Notebook entity

Image or other file resource

Example

Example

Example GET requests

filter

select

expand

expand (multiple levels)

expand & select (multiple levels)

expand & levels (multiple levels)

filter

filter & expand

filter & select & orderby

orderby

filter & top

filter & top & skip

select

select & expand & filter (multiple levels)

top & select & orderby

skip & top & select & orderby

Supported OData query string options

Examples

Supported OData operators and functions

OneNote entity properties

Example

Request and response information for GET requests

Constructing the Microsoft Graph notes service root URL

Permissions for GET requests

Related content

Geri Bildirim

Ek kaynaklar