- First 1000 people who use the link will get 2 free months of Skillshare premium: of us take notes in some way or another - on a.
- OneNote is tablet and stylus compatible, or you can even use your mouse if you’re feeling particularly artistic. To edit any pages, you’ll do so from one of the four tabs lining the top of every Notebook.
If you use the OneNote app with the right strategy, a notebook with 2–3 GB in size should not cause any issues. Here are some tips you can follow. Do not insert multiple PDF printouts in the same notebook: The printout (100 MB or more) and OCR processing can slow the indexing process and sync speed. Microsoft is bringing back the Windows desktop app for OneNote. And with that, you can start using the template function as it’s currently missing in the default Mac.
Applies to: Consumer notebooks on OneDrive | Enterprise notebooks on Office 365
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.
Take advantage of OneNote's notebook, section, and page hierarchy and easy-to-use API to help your users plan and organize ideas and information.
Note
When you use the OneNote API, you agree to the Microsoft API terms of use.
Platform overview
The OneNote service runs on the Microsoft cloud and provides a RESTful interface for programmatic access to OneNote content. The OneNote API is lightweight and simple—it's built on JSON, HTML, and OData, so you can use it with any language or platform that supports HTTP requests.
Here's a simple view of the OneNote API development stack.
First, your user must be authenticated and grant access to your app. Then you get an access token that you use to interact with OneNote content. In addition to CRUD support for OneNote resources, the API also provides capabilities such as optical character recognition (OCR), full-text search, and business card extractions.
Using the OneNote API
To use the OneNote API, you send HTTP requests to specific endpoints off OneNote's service root URL:
https://www.onenote.com/api/{version}/{location}/notes/...
You can use the OneNote API to do things like create, view, and manage pages in personal, site, and group notebooks. To give you an idea of how the API works, here's a simple POST request that creates a page in the current user's default notebook.
If successful, the request returns the following response—in this case an OData representation of the new page in JSON format.
See Create pages for a closer look at POST pages requests.
Why create OneNote apps?
Integrate OneNote to create apps that people will love. You can use the OneNote API to create and manage notes, lists, pictures, files, and more in OneNote notebooks.
Collect and organize notes and ideas
Use OneNote as a canvas where users can add and arrange their content. The OneNote API makes it easy to write apps so students can take notes and do research, families share plans and ideas, shoppers share pictures—all the things that interest people most. Your app can grab the information people want, send it to OneNote, and then help them organize it.
Capture information in many formats
Capture HTML, embed images (sourced locally or at a public URL), video, audio, email messages, and other common file types. OneNote can even render webpages and PDF files as snapshots. The OneNote API supports a set of standard HTML and CSS for OneNote page layout, so you can use tables, inline images, and basic formatting to get the look you want.
Use the OneNote ecosystem to enhance your core scenarios
Tap into other powerful OneNote API features. The API runs OCR on images, supports full-text search, auto-syncs clients, processes images, and extracts business card captures and online product and recipe listings. Use OneNote as your digital memory store in the cloud for notes and lightweight media, or as a data feed for domain-specific data.
Reach millions of OneNote users on all major platforms
Use OneNote to increase your app usage. Pre-installed on new Windows devices, available for popular platforms, on the web as OneNote Online, and part of Office 365—100+ million people worldwide actively use OneNote. When you publish apps that leverage the feature-rich OneNote environment, the cross-platform market potential is simply too big to ignore.
Get started with the OneNote API
Use samples and tutorials to start coding fast, try out our interactive consoles, or dive deeper with our documentation.
OneNote samples and tutorials
These samples and tutorials show the basics of using the OneNote API on different platforms (see all our samples on GitHub).
Platform | Samples and tutorials |
---|---|
iOS | iOS-REST-API-Explorer (MSA only) Tutorial |
Windows | OneNoteAPISampleWinUniversal |
Android | Android-REST-API-Explorer |
PHP | OneNoteAPISamplePHP (MSA only) |
Node.js | OneNoteAPISampleNodejs (MSA only) |
Ruby | OneNoteAPISampleRuby (MSA only) |
ASP.NET MVC | Tutorial (Azure AD only) |
*MSA = Microsoft account authentication, Azure AD = Azure Active Directory authentication
How-to and conceptual articles
When you're ready to dig deeper, browse our how-to and conceptual articles to learn more about what you can do with OneNote.
SDKs for OneNote development
OneNote apps can use the OneDrive API SDK to get the access tokens that are required for all requests to the OneNote API. The SDK makes authentication easier for you. You just provide your identity information and integrate a few calls, and the SDK handles everything from sign in and consent to getting, storing, and refreshing tokens. Then, you can make REST calls to the OneNote API. Our iOS tutorial shows how you can use the SDK in a OneNote app.
All versions of the SDK support Microsoft account authentication (for consumer notebooks), and some also support Azure Active Directory (for enterprise notebooks). See the OneDrive documentation for the current list of supported platforms.
Note
The OneDrive API SDK replaces the Live SDK. The Live SDK is deprecated but will continue to support existing OneNote applications that use it. For new development, use the OneDrive API SDK.
At some point, we may provide libraries that both handle authentication and support native calls to the OneNote API, but for now you can use the OneDrive API SDK.
Alternatively, enterprise apps can use the Active Directory Authentication Library (ADAL) to access Office 365 and SharePoint-hosted notebooks. You might consider using ADAL directly if there's no SDK available for your platform or if you want more control over the auth process. Our ASP.NET MVC tutorial shows how you can use ADAL in a OneNote app.
Important
To interact with OneNote content and resources, you should always use the OneNote API. Don't use the OneDrive API.
For more information, see OneNote resources.
Connect with us
Onenote App For Laptop
Stay tuned as we expand and improve. We always want to hear your questions and comments, help you figure things out, and keep you up-to-date. Here's how you can connect with us:
- Read the OneNote Developer Blog for news and helpful tips.
- Get expert answers on Stack Overflow.
- Follow us on Twitter: @onenotedev.
- Send us your ideas and comments on UserVoice.
What's changed
The following entries highlight changes made to the OneNote API and documentation during the past year:
July 2016
- Added the Work with staff notebooks topic.
- Documented support for embedded videos.
May 2016
- Added page preview support. Use the
../pages/{id}/preview
endpoint to get text and image preview content for a page. Read the Page preview API blog post to learn more. - Documented support for the
../users/{id}/notes/
location, which enables access to OneNote content that the specified user (in the URL) has shared with the current user. Enterprise notebooks only. - Added permission management APIs that allow you to set access permissions on a notebook, section group, or section. Enterprise notebooks only.
- Added new class notebook operations: Insert sections from other notebooks, add a Teacher Only section group, delete class notebooks, create class notebooks in a specified language, send an email notification for a new class notebook. Enterprise notebooks only.
- Added support for the
<pre>
element in page HTML content. Now, content captured from sites like MSDN and StackOverflow renders with proper code formatting.
March 2016
- Released
GET /pages/{id}/content?preAuthenticated=true
to production. When thepreAuthenticated=true
query string option is used to retrieve page content, the output HTML includes public URLs to the image resources on the page. These pre-authenticated URLs are valid for one hour. See One time Authentication for Public Resource. - Released
PATCH /sections/{id}
to production. This lets you rename a section by sending an application/json content type in the message body, like this:{ 'name': 'New section name' }
February 2016
- Added the Subscribe for webhooks and Work with class notebooks topics. Webhooks is currently supported only for consumer notebooks on OneDrive.
January 2016
- Turned on throttling. Learn more about OneNote API throttling and best practices to avoid it.
- Added the Supported REST operations and Copy notebooks, sections, and pages topics. Copy functionality is currently available only for Office 365 notebooks.
November 2015
- Support for Office 365 notebooks moved from preview to production. Includes support for notebooks on SharePoint sites and Office 365 groups, and the Notes.Read.All and Notes.ReadWrite.All permissions that are required to access these organization-level notebooks.
- Released
POST /sectiongroups/{id}/sections
,POST /notebooks/{id}/sectiongroups
, andPOST /sectiongroups/{id}/sectiongroups
to production. - Released CopyNotebook, CopyToNotebook, CopyToSectionGroup, CopyToSection to production for Office 365 notebooks.
- Added the parentSection and parentNotebook navigation properties to pages. The default
GET pages
query expands parentSection and selects the section's name, id, and self properties. - Added the level and order properties to pages. To retrieve these properties, include the pagelevel parameter in a query for the pages collection in a section or for a specific page. Example:
GET ../sections/{id}/pages?pagelevel=true
orGET ../pages/{id}?pagelevel=true
- The maximum number of characters in a notebook name changed from 50 to 128.
- Moved the how-to and conceptual documentation. The new documentation covers both consumer and enterprise OneNote APIs.
September 2015
- The maximum number of pages returned in a
GET pages
request using the top query string option changed from 500 to 100.
July 2015
- Released two OneNote REST API explorer sample apps:
- iOS REST API Explorer
- Android REST API Explorer - Released
DELETE pages
to production. - Updated the root service URL in the how-to topics to use the new, recommended
/me/notes/
route:https://www.onenote.com/api/v1.0/me/notes/
June 2015
- Published the Use note tags topic.
See also
-->There are two versions of OneNote that you can deploy to users in your organization who have devices running Windows:
- OneNote: the desktop version, which was previously named OneNote 2016.
- OneNote for Windows 10: the Microsoft Store app that's available only on Windows 10.
While both versions are supported and can be installed on the same device, OneNote is the recommended version for enterprise environments. OneNote provides more features and allows you to customize user settings through Group Policy.
Note
OneNote still appears as OneNote 2016 for the following installations:
- Version 2003 or earlier of Microsoft 365 Apps
- Volume licensed versions of Office 2019, such as Office Professional Plus 2019.
OneNote deployment guidance
You can use the Office Deployment Tool or enterprise deployment software, such as Microsoft Endpoint Configuration Manager, to include or exclude OneNote when you deploy Office in your organization.
As of March 2020, OneNote is included alongside the other Office apps, such as Word, Excel, and PowerPoint, when you deploy Microsoft 365 Apps or Office 2019. There are no additional steps you need to take to include OneNote with new installations of Office. But, always be sure to check the deployment settings before you deploy, for example when using the wizards in Configuration Manager (current branch) or Microsoft Intune.
To add OneNote to an existing installation of Office
If Office is already installed on the device, but OneNote didn't get installed previously, you can run the Office Deployment Tool on the device and use the following configuration.xml file to add OneNote.
Although you're deploying the freemium version of OneNote, the first time the user opens OneNote after it's installed, the license will update automatically to the same license as the version of Office already installed on the device.
Note
- Using OneNoteFreeRetail isn't supported with volume licensed versions of Office 2019, such as Office Professional Plus 2019 or Office Standard 2019. To add OneNote back to those versions of Office, you can run an Online Repair.
- If you deploy the freemium version of OneNote, when you go to Control Panel > Programs > Programs and Features, OneNote will appear as a standalone entry named Microsoft OneNote Home and Student 2016.
To exclude OneNote from being installed
There are different ways to exclude OneNote from being installed with Office, depending on which deployment method you're using, as shown in the following table.
Method | Instructions |
---|---|
Office Deployment Tool | You can use the ExcludeApp element in your configuration.xml file. We recommend that you use the Office Customization Tool to help you create your configuration.xml file. |
Microsoft Endpoint Configuration Manager (current branch) | In the Office 365 Client Installation wizard, you can set OneNote to the Off position when you configure the Office settings. |
Microsoft Intune | On the Configure app suite page, you can clear the check box for OneNote in the Select Office apps drop-down list. |
But, if you're allowing your users to install Office for themselves from the Office 365 portal, there is no way to exclude OneNote from being installed.
OneNote for Windows 10 deployment guidance
OneNote for Windows 10 is installed by default on computers running Windows 10. Users can also install it directly from the Microsoft Store, if you allow them to install apps from there. In either case, updates to OneNote for Windows 10 come directly from the Microsoft Store.
If you don't want your users to install apps directly from the Microsoft Store, you can set up the Microsoft Store for Business in your organization. This option allows you to control which Microsoft Store apps your users can install, including OneNote for Windows 10. For more information, see Microsoft Store for Business overview
If your users already use OneNote for Windows 10, they may continue to use it. We recommend excluding OneNote for Windows 10 for new deployments. We don't recommend uninstalling OneNote for Windows 10 for existing users because uninstalling an app permanently removes any notebook changes in the local cache that haven't been synchronized. If you plan to uninstall OneNote for Windows 10 for existing users, ensure that all open notebooks have finished synchronizing before uninstalling.
All notebooks supported by OneNote for Windows 10 are also fully supported by OneNote. All cloud-based notebooks associated with their user account will be accessible in OneNote after they sign in with that same user account.
To exclude OneNote for Windows 10 from a Windows image
To remove OneNote for Windows 10 from a Windows image so that OneNote for Windows 10 won't be installed when a new user account is created, you can use the Remove-AppxProvisionedPackage cmdlet. For the package name parameter, you should use Microsoft.Office.OneNote_2015.9126.21251.0_neutral_~_8wekyb3d8bbwe.
Additional information about deploying OneNote
OneNote training resources We're providing free and shareable eBooks to help your users transition to the user interface and functionalities in OneNote.
Configure OneNote settings: You can use Group Policy to configure certain OneNote settings for your users. To use Group Policy, download the latest Administrative Template files (ADMX/ADML) for Office from the Microsoft Download Center and implement the policy settings by using Active Directory Domain Services (AD DS).
Note
Onenote App User
- Group Policy requires the devices with OneNote to be joined to an Active Directory domain.
- Most of these same policy settings can be applied by using the Office cloud policy service, which doesn't require the device to be joined to a domain.
- Neither Group Policy nor Office cloud policy service can be used with Microsoft 365 Apps for business or with OneNote for Windows 10.
Support dates: In November 2019, we announced that mainstream support for OneNote will continue until October 2023. Extended support remains the same, ending in October 2025. These dates align with the support dates for Office 2019. These specific support dates apply only to OneNote included with versions of Office, such as Office Professional Plus 2016, that are available as a one-time purchase or through volume licensing agreements.
Supported languages: While both OneNote and OneNote for Windows 10 are available in most of the same languages, there are a few differences. The lists of the supported languages are available here: OneNote, OneNote for Windows 10
Other platforms: There are also versions of OneNote for Mac, iPad, iPhone, Android, and for web browsers. For more information, see What's the difference between the OneNote versions?
Comments are closed.