OneNote is a popular note-taking tool that’s available online and on many mobile and tablet platforms. By integrating your apps with OneNote, it’s easier than ever to create empowering apps on your favorite platforms and reach millions of users worldwide.
GET https://login.live.com/oauth20_authorize.srf
?response_type=token
&client_id={client_id}
&redirect_uri={redirect_uri}
&scope={scope}
Datatype | Description | Example |
---|---|---|
Datepicker | String which includes date and time | |
Map | String which includes latitude and longitude coma separated | |
List | Simple array | |
Select | String with predefined values | |
Array | Array of objects |
Creates a new page in the user’s default section and notebook.
Field | Type | Description |
---|---|---|
accessToken | credentials | A valid OAuth token provided to the app based on the user credentials and the user having authorized access. |
content | String | Page content |
Creates a new page in the specified section.
Field | Type | Description |
---|---|---|
accessToken | credentials | A valid OAuth token provided to the app based on the user credentials and the user having authorized access. |
content | String | Page content |
sectionId | String | The id of section where the page is to be created. |
Creates a new page in the specified section of the user’s default notebook. If the section doesn’t exist (or was renamed), the API will create the section.
Field | Type | Description |
---|---|---|
accessToken | credentials | A valid OAuth token provided to the app based on the user credentials and the user having authorized access. |
content | String | Page content |
sectionName | String | The name of the section in the default notebook to create this new page in, if the section does not already exist. |
Gets a collection of pages (metadata) across all notebooks in OneDrive that the user can access.
Field | Type | Description |
---|---|---|
accessToken | credentials | A valid OAuth token provided to the app based on the user credentials and the user having authorized access. |
filter | String | A Boolean expression for whether to include a particular entry. Example: title eq ‘Trip Planning’. |
orderBy | String | Expression specifying order. Default is lastModifiedTime desc. Example: createdTime. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: parentNotebook or parentSection |
top | Number | Specifies to return only the first n results. Default is 20, maximum is 100. |
skip | Number | Specifies to skip the first n results, typically used for paging. Example: 5. |
search | String | Specifies the term or phrase to search for in the page title, page body, image alt text, and image OCR text. |
count | Select | Specifies to include the count of the returned collection. |
Gets a collection of pages (metadata) under the specified section.
Field | Type | Description |
---|---|---|
accessToken | credentials | A valid OAuth token provided to the app based on the user credentials and the user having authorized access. |
id | String | Section ID. |
filter | String | A Boolean expression for whether to include a particular entry. Example: title eq ‘Trip Planning’. |
orderBy | String | Expression specifying order. Default is lastModifiedTime desc. Example: createdTime. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: parentNotebook or parentSection |
top | Number | Specifies to return only the first n results. Default is 20, maximum is 100. |
skip | Number | Specifies to skip the first n results, typically used for paging. Example: 5. |
search | String | Specifies the term or phrase to search for in the page title, page body, image alt text, and image OCR text. |
count | Select | Boolean. Specifies to include the count of the returned collection. |
pageLevel | Select | Boolean. Returns the level and order properties of the pages. |
Gets a collection of pages (metadata) under the specified section.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | Section ID. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: parentNotebook or parentSection |
pageLevel | Select | Boolean. Returns the level and order properties of the pages. |
Gets a collection of pages (metadata) under the specified section.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | Section ID. |
includeIDs | Select | Boolean. ‘true’ to include auto-generated element IDs. |
preAuthenticated | Select | Boolean. ‘true’ to return URLs that temporarily enable public access to the image resources on the page.‘true’ to include auto-generated element IDs. |
Gets preview content for a specific page.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | Section ID. |
You can’t recover deleted data, so be careful when using this method. Deleting pages using the API deletes them permanently. They are not added to the OneNote Recycle Bin.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | Section ID. |
Gets all sections to which a user has access in all OneNote notebooks that are stored in Microsoft OneDrive. This includes sections in notebooks that are both owned by and shared with the user. You can also retrieve all sections to which the user has access inside a specific notebook or section group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
filter | String | A Boolean expression for whether to include a particular entry. Example: title eq ‘Trip Planning’. |
orderBy | String | Expression specifying order. Default is lastModifiedTime desc. Example: createdTime. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: parentNotebook or parentSection |
top | Number | Specifies to return only the first n results. Default is 20, maximum is 100. |
skip | Number | Specifies to skip the first n results, typically used for paging. Example: 5. |
search | String | Specifies the term or phrase to search for in the page title, page body, image alt text, and image OCR text. |
count | Select | Specifies to include the count of the returned collection. |
Gets a collection of sections from the specified notebook.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | Notebook id. |
filter | String | A Boolean expression for whether to include a particular entry. Example: title eq ‘Trip Planning’. |
orderBy | String | Expression specifying order. Default is lastModifiedTime desc. Example: createdTime. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: parentNotebook or parentSection |
top | Number | Specifies to return only the first n results. Default is 20, maximum is 100. |
skip | Number | Specifies to skip the first n results, typically used for paging. Example: 5. |
search | String | Specifies the term or phrase to search for in the page title, page body, image alt text, and image OCR text. |
count | Select | Specifies to include the count of the returned collection. |
Gets a collection of sections from the specified section group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | The id of the section group that contains the section. |
filter | String | A Boolean expression for whether to include a particular entry. Example: title eq ‘Trip Planning’. |
orderBy | String | Expression specifying order. Default is lastModifiedTime desc. Example: createdTime. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: parentNotebook or parentSection |
top | Number | Specifies to return only the first n results. Default is 20, maximum is 100. |
skip | Number | Specifies to skip the first n results, typically used for paging. Example: 5. |
search | String | Specifies the term or phrase to search for in the page title, page body, image alt text, and image OCR text. |
count | Select | Specifies to include the count of the returned collection. |
Gets a specific section inside a OneNote notebook that is stored in Microsoft OneDrive. This can be a section in a notebook that is either owned by or shared with the user.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | Section id. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: parentNotebook or parentSection |
Creates a new section in the specified notebook on Microsoft OneDrive.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | The id of the notebook where you want to create the section. |
name | String | Section name |
Creates a new section in the specified section group on Microsoft OneDrive.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | The id of the section group where you want to create the section. |
name | String | Section name |
Renames the specified section.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | The id of the section to update. |
name | String | Section name |
Gets all section groups to which a user has access in all OneNote notebooks that are stored in Microsoft OneDrive. This includes section groups in notebooks that are both owned by and shared with the user. You can also retrieve all section groups to which a user has access inside a specific notebook or section group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
filter | String | A Boolean expression for whether to include a particular entry. Example: title eq ‘Trip Planning’. |
orderBy | String | Expression specifying order. Default is lastModifiedTime desc. Example: createdTime. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: parentNotebook or parentSection |
top | Number | Specifies to return only the first n results. Default is 20, maximum is 100. |
skip | Number | Specifies to skip the first n results, typically used for paging. Example: 5. |
search | String | Specifies the term or phrase to search for in the page title, page body, image alt text, and image OCR text. |
count | Select | Specifies to include the count of the returned collection. |
Gets a collection of section groups inside a specific section group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | The id of the parent section group. |
filter | String | A Boolean expression for whether to include a particular entry. Example: title eq ‘Trip Planning’. |
orderBy | String | Expression specifying order. Default is lastModifiedTime desc. Example: createdTime. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: parentNotebook or parentSection |
top | Number | Specifies to return only the first n results. Default is 20, maximum is 100. |
skip | Number | Specifies to skip the first n results, typically used for paging. Example: 5. |
search | String | Specifies the term or phrase to search for in the page title, page body, image alt text, and image OCR text. |
count | Select | Specifies to include the count of the returned collection. |
Gets a specific section group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | The id of the parent section group. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: parentNotebook or parentSection |
Creates a new section group in the specified notebook.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | The id of the notebook where you want to create the section group. |
name | String | Section group |
Creates a new section group in the specified section group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | The id of the notebook where you want to create the section group. |
name | String | Section group |
Gets all notebooks to which a user has access in Microsoft OneDrive. This includes notebooks that are both owned by and shared with the user.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | The id of the notebook where you want to create the section group. |
orderBy | String | Expression specifying order. Default is lastModifiedTime desc. Example: createdTime. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: sections or sectionGroups |
top | Number | Specifies to return only the first n results. Default is 20, maximum is 100. |
skip | Number | Specifies to skip the first n results, typically used for paging. Example: 5. |
search | String | Specifies the term or phrase to search for in the page title, page body, image alt text, and image OCR text. |
count | Select | Specifies to include the count of the returned collection. |
Gets a specific notebook.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
id | String | The id of the notebook where you want to create the section group. |
select | String | Expression specifying the properties to return |
expand | Select | Expression specifying the navigation properties to return inline. Must be: sections or sectionGroups |
Creates a new notebook for the user in Microsoft OneDrive.
Field | Type | Description |
---|---|---|
accessToken | credentials | The id of page. |
name | String | Section name |