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.

We have partnered with UserVoice, a third-party service and your use of the portal and your submission is subject to the UserVoice Terms of Service & Privacy Policy, including the license terms. Please do not send any novel or patentable ideas, copyrighted materials, samples or demos for which you do not want to grant a license to Microsoft.

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. 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
      Signed in as (Sign out)
      You have left! (?) (thinking…)
      Completed  ·  2 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
    • API support for tags, including custom tags

      Add support for tagging with both the built-in and user's custom tags

      126 votes
      Vote
      Sign in
      Check!
      (thinking…)
      Reset
      or sign in with
      • facebook
      • google
        Password icon
        Signed in as (Sign out)
        You have left! (?) (thinking…)
        11 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
      • 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
          Signed in as (Sign out)
          You have left! (?) (thinking…)
          5 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
        • Recognize handwritten text in images

          Right now, the OneNote API recognizes printed text. This would expand support to recognize handwritten text too so it could be indexed and searched for.

          166 votes
          Vote
          Sign in
          Check!
          (thinking…)
          Reset
          or sign in with
          • facebook
          • google
            Password icon
            Signed in as (Sign out)
            You have left! (?) (thinking…)
            3 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
          • API to GET a list of OneNote pages back

            Allow HTTP GET on https://www.onenote.com/api/v1.0/pages resource. Depending on the permission scope that the app has, this will either return all the pages across all of the user's notebooks, or this will return all the pages created by the app in the user's notebooks. Sorting can be done by created date/time or title, in either ascending or descending order.

            68 votes
            Vote
            Sign in
            Check!
            (thinking…)
            Reset
            or sign in with
            • facebook
            • google
              Password icon
              Signed in as (Sign out)
              You have left! (?) (thinking…)
              0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
            • Search API (consumer)

              Would be great to have a search API that returns a Bing/Goolge-like result list.

              21 votes
              Vote
              Sign in
              Check!
              (thinking…)
              Reset
              or sign in with
              • facebook
              • google
                Password icon
                Signed in as (Sign out)
                You have left! (?) (thinking…)
                0 comments  ·  REST API  ·  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
                  Signed in as (Sign out)
                  You have left! (?) (thinking…)
                  Completed  ·  3 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
                    Signed in as (Sign out)
                    You have left! (?) (thinking…)
                    1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                    Completed  ·  James 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.

                  • 78 votes
                    Vote
                    Sign in
                    Check!
                    (thinking…)
                    Reset
                    or sign in with
                    • facebook
                    • google
                      Password icon
                      Signed in as (Sign out)
                      You have left! (?) (thinking…)
                      7 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
                        Signed in as (Sign out)
                        You have left! (?) (thinking…)
                        4 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                        Completed  ·  Gareth 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.

                      • 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
                          Signed in as (Sign out)
                          You have left! (?) (thinking…)
                          0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                        • Return pages matching a search criteria

                          Structured search, so on create/modify date, content, title, etc.

                          Then works like a GET on https://www.onenote.com/api/v1.0/pages resource.

                          4 votes
                          Vote
                          Sign in
                          Check!
                          (thinking…)
                          Reset
                          or sign in with
                          • facebook
                          • google
                            Password icon
                            Signed in as (Sign out)
                            You have left! (?) (thinking…)
                            1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                          • 11 votes
                            Vote
                            Sign in
                            Check!
                            (thinking…)
                            Reset
                            or sign in with
                            • facebook
                            • google
                              Password icon
                              Signed in as (Sign out)
                              You have left! (?) (thinking…)
                              1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                            • API to enable creating a page in a specific notebook and section

                              Right now, the API only creates pages in the default notebook and section. Please provide a way to allow my users to choose the specific notebook and/or section where the page will get created into.

                              81 votes
                              Vote
                              Sign in
                              Check!
                              (thinking…)
                              Reset
                              or sign in with
                              • facebook
                              • google
                                Password icon
                                Signed in as (Sign out)
                                You have left! (?) (thinking…)
                                3 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                              • API to retrieve page content

                                Right now, the API allows using POST to create pages using HTML. Please provide the ability to get the HTML for those pages back out again.

                                51 votes
                                Vote
                                Sign in
                                Check!
                                (thinking…)
                                Reset
                                or sign in with
                                • facebook
                                • google
                                  Password icon
                                  Signed in as (Sign out)
                                  You have left! (?) (thinking…)
                                  4 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                                • 22 votes
                                  Vote
                                  Sign in
                                  Check!
                                  (thinking…)
                                  Reset
                                  or sign in with
                                  • facebook
                                  • google
                                    Password icon
                                    Signed in as (Sign out)
                                    You have left! (?) (thinking…)
                                    1 comment  ·  Samples  ·  Flag idea as inappropriate…  ·  Admin →
                                  • 11 votes
                                    Vote
                                    Sign in
                                    Check!
                                    (thinking…)
                                    Reset
                                    or sign in with
                                    • facebook
                                    • google
                                      Password icon
                                      Signed in as (Sign out)
                                      You have left! (?) (thinking…)
                                      1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                                    • Provide proper reference documentation

                                      I was expecting to find a proper REST reference documentation like this one (http://www.twilio.com/docs/api/rest). I couldn't find it.

                                      4 votes
                                      Vote
                                      Sign in
                                      Check!
                                      (thinking…)
                                      Reset
                                      or sign in with
                                      • facebook
                                      • google
                                        Password icon
                                        Signed in as (Sign out)
                                        You have left! (?) (thinking…)
                                        1 comment  ·  Documentation  ·  Flag idea as inappropriate…  ·  Admin →
                                      • 9 votes
                                        Vote
                                        Sign in
                                        Check!
                                        (thinking…)
                                        Reset
                                        or sign in with
                                        • facebook
                                        • google
                                          Password icon
                                          Signed in as (Sign out)
                                          You have left! (?) (thinking…)
                                          0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                                        • 0 votes
                                          Vote
                                          Sign in
                                          Check!
                                          (thinking…)
                                          Reset
                                          or sign in with
                                          • facebook
                                          • google
                                            Password icon
                                            Signed in as (Sign out)
                                            You have left! (?) (thinking…)
                                            1 comment  ·  Samples  ·  Flag idea as inappropriate…  ·  Admin →
                                          • Don't see your idea?

                                          OneNote Developer APIs

                                          Feedback and Knowledge Base