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. Set transparency of graphic items

    Would be nice to set transparency and other aspects on an image. Especially when doing background items, would be nice to use an image like a watermark. (also convert to gray scale)

    1 vote
    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  ·  Flag idea as inappropriate…  ·  Admin →
    • Export Options - what to include/how to include

      Currently you have no real control how OneNote exports. If you want to maintain graphics made part of the page they only show up in PDF export. Colors of pages don't show up in anything. Should be able to selectively accept/reject which things you want o do with how the application exports into different formats.

      1 vote
      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  ·  Flag idea as inappropriate…  ·  Admin →
      • OneNote pictures

        When you drap and drop a picture onto a page, their order is determined when they are dropped, with last item being on top. Though you can right click and see an order option it has no affect, nor does the Arrange option on Draw tab.

        Needs to be able to arrange order: send to back, bring to front, forward and back.

        1 vote
        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  ·  Flag idea as inappropriate…  ·  Admin →
        • Specify default notebook

          GET /notebooks shows us an isDefault parameter per notebook but it's read-only, there's no ability to change this. (indeed there's no PATCH for notebooks at all)

          Being able to change the default note book would be very useful. I'm sure I'm not on my own by never using the "[My name]'s Notebook" I'd much rather have clippings go to the actual notebook that I use day to day.

          Until the time when the OneDrive UI or online OneNote UI allows us ot set a default notebook for clipping etc can you at least let us do it programmatically via the…

          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…)
            0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
          • I'd like an API to determine who a notebook or section has been shared with.

            The existing API lets me know that a notebook IS shared, but as far as I can tell does not have any mechanism for telling my code who has access.

            7 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 →
            • An API should exist to set sharing on a notebook or section

              This is necessary for a variety of publishing scenarios.

              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…)
                0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
              • Add a 'GET' page example to the OneNoteAPISampleNodejs

                It'd be nice if there was an example of retrieving a note using https://github.com/OneNoteDev/OneNoteAPISampleNodejs
                All of the examples only show how to do a 'POST' to create different types of pages.

                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…)
                  0 comments  ·  Samples  ·  Flag idea as inappropriate…  ·  Admin →
                • POST with {id} to update an entire page

                  I see this is in the roadmap but hasn't made it to Beta - this would be the POST equivalent of the GET to get a page, replacing it in its entirety.

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

                    How about some clear instructions. Not those idiotic videos, but clear written instructins

                    7 votes
                    Vote
                    Sign in
                    Check!
                    (thinking…)
                    Reset
                    or sign in with
                    • facebook
                    • google
                      Password icon
                      Signed in as (Sign out)
                      You have left! (?) (thinking…)
                      2 comments  ·  Documentation  ·  Flag idea as inappropriate…  ·  Admin →
                    • Embedded codeboxes

                      Provide support to copy/paste in code snippets into oneNote pages. Maybe even preserve syntax highlighting (atleast from Visual Studios).

                      35 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  ·  Flag idea as inappropriate…  ·  Admin →
                      • [Possibilities / capabilities of the programmer] Möglichkeiten/Fähigkeiten der Programmierer

                        Fragt Euch doch mal warum ein einzelner Programmierer mit Gem für OneNote so viele Funktionen einbauen kann die das ganze Team nicht hinbekommt?

                        Wo habert es?
                        Das es keinen Bedarf an den Funktionen gibt kann eher nicht sein, sonst würde Gem sich nicht verkaufen!

                        2 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  ·  Flag idea as inappropriate…  ·  Admin →
                        • Create a OneNote "Digest" option in IFTTT

                          In IFTTT, there are email digest options that allow a day's or week's worth of content to be dumped at a specific time to an email. Allow the same feature in OneNote so that each trigger doesn't create a separate page, but aggregates a day's worth (or a set number) of content on one page.

                          17 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  ·  Others  ·  Flag idea as inappropriate…  ·  Admin →
                          • Code samples for web-app js authentication

                            Google wraps up their auth api into a real nice JS lib that you can just load: <script type="text/javascript" src="https://apis.google.com/js/api.js?onload=onApiLoad"></script>
                            <script>

                            Some usage: http://stackoverflow.com/a/22484429/4142536

                            I'd love for this to exist for OneNote authentication. It should be dead-simple for me to integrate one-note into my JS web-app.

                            13 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  ·  Flag idea as inappropriate…  ·  Admin →
                            • Why don't you provide a API to capture a web page as HTML content but not image ?

                              The web page screenshot is not very convenient to read, edit and copy. I think you should provide an API which can accept a URL and save the webpage content as HTML format.

                              33 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 →
                              • Keep the github samples up to date

                                As you add new capabilities, please update your samples on GitHub. I am particularly interested in the windows phone and windows store app samples.

                                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…)
                                  2 comments  ·  Samples  ·  Flag idea as inappropriate…  ·  Admin →
                                • Bug Report : Some images will be lost when I capture a webpage with the API.

                                  Some images will be lost when I capture a webpage with the API . This will undermine our confidence to OneNote API.

                                  3 votes
                                  Vote
                                  Sign in
                                  Check!
                                  (thinking…)
                                  Reset
                                  or sign in with
                                  • facebook
                                  • google
                                    Password icon
                                    Signed in as (Sign out)
                                    You have left! (?) (thinking…)
                                    2 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                                  • Why the width property does not work in OneNote API ?

                                    I try to Capture web page snapshots with the OneNote API follow the document :

                                    http://msdn.microsoft.com/en-us/library/dn575431(v=office.15).aspx

                                    But I found the width property does not work allways.

                                    When I set the width to 200,300,600 or 800px, the render result is 1024px.

                                    Who can help me ?

                                    <img data-render-src="http://www.bing.com&quot; width="200"/>

                                    10 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 →
                                      started  ·  Nick Barnwell responded

                                      This is a regression on our side. We’ll mark this request as “Finished” once we’ve fixed it. Thank you for bringing it to our attention!

                                      Cheers,
                                      Nick

                                    • Add-in Samples alongside API Samples

                                      I would love to see an end to end add-in sample that we can leverage. Today they are in peoples blogs, etc. and it is important to know when to use one or another.

                                      2 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  ·  Samples  ·  Flag idea as inappropriate…  ·  Admin →
                                      • Include a 'parent' property for Pages and Sections

                                        Include a parent property in API results so you can work backwards for the tree (or can build a tree with a single API call).

                                        5 votes
                                        Vote
                                        Sign in
                                        Check!
                                        (thinking…)
                                        Reset
                                        or sign in with
                                        • facebook
                                        • google
                                          Password icon
                                          Signed in as (Sign out)
                                          You have left! (?) (thinking…)
                                          planned  ·  1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
                                        • OneNote Lens API

                                          It would be great for there to be an API which allows the user of OneNote Lens camera scanning functions.

                                          I'd like to be able to scan documents and have the API return the cleaned up image and OCR data to my app.

                                          My app would then allow the user to enter metadata onto the image in the same way notes can be added to PDF documents. The metadata would then be used to group and categorize the files, allowing the user to automatically archive similar documents.

                                          6 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  ·  Others  ·  Flag idea as inappropriate…  ·  Admin →
                                          • Don't see your idea?

                                          OneNote Developer APIs

                                          Feedback and Knowledge Base