OneNote Developer APIs

Welcome to the feedback forum for OneNote’s developer platform and APIs! This is the place for developers to send us feedback and suggestions. To share feedback about OneNote’s apps, please visit our user forum instead. For “How To” questions, please visit StackOverflow.

How can we improve the OneNote APIs and developer platform? Vote for an existing idea or share a new one.

You've used all your votes and won't be able to post a new idea, but you can still search and comment on existing ideas.

There are two ways to get more votes:

  • When an admin closes an idea you've voted on, you'll get your votes back from that idea.
  • You can remove your votes from an open idea you support.
  • To see ideas you have already voted on, select the "My feedback" filter and select "My open ideas".
(thinking…)

Enter your idea and we'll search to see if someone has already suggested it.

If a similar idea already exists, you can support and comment on it.

If it doesn't exist, you can post your idea so others can support it.

Enter your idea and we'll search to see if someone has already suggested it.

  1. Add VBA as a Macro Language for OneNote Desktop

    I would find it useful to write VBA to automate certain tasks without using OneNote API. I know VBA and could interoperate Office applications easily if VBA could automate OneNote. I do not know the OneNote API; learning it would be a significant learning curve. Why should OneNote be any different than the rest of the Office offerings?

    9 votes
    Vote
    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      I agree to the terms of service
      Signed in as (Sign out)
      You have left! (?) (thinking…)
      3 comments  ·  Others  ·  Flag idea as inappropriate…  ·  Admin →
    • 22 votes
      Vote
      Sign in
      Check!
      (thinking…)
      Reset
      or sign in with
      • facebook
      • google
        Password icon
        I agree to the terms of service
        Signed in as (Sign out)
        You have left! (?) (thinking…)
        1 comment  ·  Samples  ·  Flag idea as inappropriate…  ·  Admin →
      • Support OneNote Notebooks Hosted in OneDrive for Business, or some other cloud/internet based storage location

        Right now the API only works for notebooks in OneDrive, but I would like the same capabilities for my work notebook which I have hosted in my organizations O365 OneDrive for Business. Equally important would be in SharePoint where I may have site notebooks that I collaborate on with coworkers

        138 votes
        Vote
        Sign in
        Check!
        (thinking…)
        Reset
        or sign in with
        • facebook
        • google
          Password icon
          I agree to the terms of service
          Signed in as (Sign out)
          You have left! (?) (thinking…)
          12 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
        • API to append/prepend to a page

          Ability to incrementally add to page content just by posting the new part you want - either at the top or the bottom of a page, to support diaries/logs etc.

          48 votes
          Vote
          Sign in
          Check!
          (thinking…)
          Reset
          or sign in with
          • facebook
          • google
            Password icon
            I agree to the terms of service
            Signed in as (Sign out)
            You have left! (?) (thinking…)
            4 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
            Completed  ·  Gareth JonesGareth Jones responded

            This is now in production. Use the PATCH command with a target of body. We do not plan to support prepend at this time.

          • Store hidden data in pages

            Ability to store hidden data (not visible to the user) in page content or page metadata.

            Similar to how "CreatedByAppId" is stored.

            16 votes
            Vote
            Sign in
            Check!
            (thinking…)
            Reset
            or sign in with
            • facebook
            • google
              Password icon
              I agree to the terms of service
              Signed in as (Sign out)
              You have left! (?) (thinking…)
              2 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
            • Ability to get pre-auth'd image URLs from a OneNote page that a browser can GET

              When you retrieve HTML from the OneNote API, the image URLs that are referenced need to have an OAUTH token added to them before they can be called. It would be great to be able to get a version of the HTML that had pre-auth'd tokens so the HTML could be rendered in a browser.

              22 votes
              Vote
              Sign in
              Check!
              (thinking…)
              Reset
              or sign in with
              • facebook
              • google
                Password icon
                I agree to the terms of service
                Signed in as (Sign out)
                You have left! (?) (thinking…)
                2 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
              • 78 votes
                Vote
                Sign in
                Check!
                (thinking…)
                Reset
                or sign in with
                • facebook
                • google
                  Password icon
                  I agree to the terms of service
                  Signed in as (Sign out)
                  You have left! (?) (thinking…)
                  7 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                • Give tags unique IDs

                  In the OneNote DOM tags are quite hard to reference, one has to track an outline and this may contain more than one tag (and of course the outline IDs change from device to device).

                  Can you take this pain away for us please? Keep track of the tags in the outline and when you deliver us tagged content via the API, give each tag its own ID so we can easily reference it?

                  9 votes
                  Vote
                  Sign in
                  Check!
                  (thinking…)
                  Reset
                  or sign in with
                  • facebook
                  • google
                    Password icon
                    I agree to the terms of service
                    Signed in as (Sign out)
                    You have left! (?) (thinking…)
                    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                  • Syntax Highlightighting

                    As a developer, I would like to have code snippets in one note. It would be great if I can have syntax highlighting. Can be retaining while copy-pasting from an IDE or something like select the code and apply syntax highlighting in language of your choice

                    38 votes
                    Vote
                    Sign in
                    Check!
                    (thinking…)
                    Reset
                    or sign in with
                    • facebook
                    • google
                      Password icon
                      I agree to the terms of service
                      Signed in as (Sign out)
                      You have left! (?) (thinking…)
                      5 comments  ·  Flag idea as inappropriate…  ·  Admin →

                      Hello
                      We recently overhauled the API handling of

                       tags. If you provide code under 
                       tags, we will preserve original formatting. 
                      The OneNote Web Clipper in Article mode is already using this feature. So any article clipped from a url containing code samples, should preserve original formatting in OneNote
                      Could you guys try this out and let us know if this solves your ask?

                    • Blog from OneNote

                      Would love to be able to right click a page and send it to a blog. Nice if it opened in OpenLiveWriter but even direct to web blog site would be great.

                      1 vote
                      Vote
                      Sign in
                      Check!
                      (thinking…)
                      Reset
                      or sign in with
                      • facebook
                      • google
                        Password icon
                        I agree to the terms of service
                        Signed in as (Sign out)
                        You have left! (?) (thinking…)
                        1 comment  ·  Others  ·  Flag idea as inappropriate…  ·  Admin →
                      • Provide API access at the sub-page and sub-sub-page levels.

                        Now that the OneNote API Team has started development to provide API access at the level of specifically named notebooks, section groups, sections and pages, do you agree it make sense to be consistent and include the finer hierarchical levels as well?

                        The use cases where these subIevels matter involve synchronization with hierarchically structured data from outline programs, mindmapping tools, keyword thesauri, student assigmnents and evaluations.

                        68 votes
                        Vote
                        Sign in
                        Check!
                        (thinking…)
                        Reset
                        or sign in with
                        • facebook
                        • google
                          Password icon
                          I agree to the terms of service
                          Signed in as (Sign out)
                          You have left! (?) (thinking…)
                          Completed  ·  2 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                        • API - Section Creation

                          I would love to the API to include the ability to create new sections as a trigger in Zapier. Also I would love the ability to add a due date. This would help me tremendously. I would use it as a trigger when a folder created in Dropbox to create a new section and a due date. Please, Please Please.

                          1 vote
                          Vote
                          Sign in
                          Check!
                          (thinking…)
                          Reset
                          or sign in with
                          • facebook
                          • google
                            Password icon
                            I agree to the terms of service
                            Signed in as (Sign out)
                            You have left! (?) (thinking…)
                            Completed  ·  1 comment  ·  Flag idea as inappropriate…  ·  Admin →
                          • Allow incremental page content updates, by page ID

                            Rather than having to send the entire page (which is going to result in accidental overwriting I'm sure) emulate the COM API's UpdatePageContent method which allows for just sending updated content at an outline level.

                            Please give us access to the Outline's ID in the GET response so we can store this and send changes back to it.

                            12 votes
                            Vote
                            Sign in
                            Check!
                            (thinking…)
                            Reset
                            or sign in with
                            • facebook
                            • google
                              Password icon
                              I agree to the terms of service
                              Signed in as (Sign out)
                              You have left! (?) (thinking…)
                              Completed  ·  3 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                            • API: write/read another user's notebook

                              If another user has shared a notebook with me, the API should expose this and make it available for editing (or reading, if read only).

                              This would make for some very interesting social options.

                              To be really useful It would require each user having the ability to specify a default notebook away from the API, i.e. at the OneDrive level. So if I were - say - writing a note that I wanted to 'send to Joe Blogs' that page would appear in their default notebook, not $Username's notebook, which they may not even have open.

                              13 votes
                              Vote
                              Sign in
                              Check!
                              (thinking…)
                              Reset
                              or sign in with
                              • facebook
                              • google
                                Password icon
                                I agree to the terms of service
                                Signed in as (Sign out)
                                You have left! (?) (thinking…)
                                Completed  ·  1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                              • WebClipper Support for Office 365

                                Currently the webclipper only supports Microsoft accounts, although it looks like the API now supports OneDrive for Business (in preview at least)

                                14 votes
                                Vote
                                Sign in
                                Check!
                                (thinking…)
                                Reset
                                or sign in with
                                • facebook
                                • google
                                  Password icon
                                  I agree to the terms of service
                                  Signed in as (Sign out)
                                  You have left! (?) (thinking…)
                                  Completed  ·  2 comments  ·  Flag idea as inappropriate…  ·  Admin →
                                • Api to manage todos

                                  I want to be able to find todos and the mark them as done via the api

                                  22 votes
                                  Vote
                                  Sign in
                                  Check!
                                  (thinking…)
                                  Reset
                                  or sign in with
                                  • facebook
                                  • google
                                    Password icon
                                    I agree to the terms of service
                                    Signed in as (Sign out)
                                    You have left! (?) (thinking…)
                                    Completed  ·  2 comments  ·  Flag idea as inappropriate…  ·  Admin →
                                  • 11 votes
                                    Vote
                                    Sign in
                                    Check!
                                    (thinking…)
                                    Reset
                                    or sign in with
                                    • facebook
                                    • google
                                      Password icon
                                      I agree to the terms of service
                                      Signed in as (Sign out)
                                      You have left! (?) (thinking…)
                                      1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                                    • PATCH pages without requiring html tags to have id attribute.

                                      Maybe this idea would resolve it too (https://onenote.uservoice.com/forums/245490-onenote-apis/suggestions/5680649-give-tags-unique-ids), but would be nice to edit pages with the PATCH REST API that were created in OneNote. Thanks.

                                      6 votes
                                      Vote
                                      Sign in
                                      Check!
                                      (thinking…)
                                      Reset
                                      or sign in with
                                      • facebook
                                      • google
                                        Password icon
                                        I agree to the terms of service
                                        Signed in as (Sign out)
                                        You have left! (?) (thinking…)
                                        0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                                        Completed  ·  Gareth JonesGareth Jones responded

                                        We shipped this at the end of April 2015 You can now call the GET method with the includeIDs query parameter to get a set of ids to directly patch.

                                      • PDF Rendering on Page

                                        Support for rendering a PDF file directly on the page, instead of just attaching it on the page as an icon. This would make PDFs on OneNote pages much more useful.

                                        77 votes
                                        Vote
                                        Sign in
                                        Check!
                                        (thinking…)
                                        Reset
                                        or sign in with
                                        • facebook
                                        • google
                                          Password icon
                                          I agree to the terms of service
                                          Signed in as (Sign out)
                                          You have left! (?) (thinking…)
                                          5 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                                        • OCR text recognition

                                          Recognize text on a picture.

                                          15 votes
                                          Vote
                                          Sign in
                                          Check!
                                          (thinking…)
                                          Reset
                                          or sign in with
                                          • facebook
                                          • google
                                            Password icon
                                            I agree to the terms of service
                                            Signed in as (Sign out)
                                            You have left! (?) (thinking…)
                                            1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                                            Completed  ·  James LauJames Lau responded

                                            This functionality already exists. Whenever you put an image on a OneNote page, the image will automatically be OCR’d. This is also true when you use the API to create a page with image.

                                          ← Previous 1
                                          • Don't see your idea?

                                          OneNote Developer APIs

                                          Feedback and Knowledge Base