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 OneNote add-ins to OneNote API compatible ids

    It is hard to match things in add-ins when using the API because the id's are different. There are many cases where making API calls from an add-in is useful!
    http://stackoverflow.com/questions/40491066/difference-between-notebook-id-by-officejs-and-onenote-api
    Please add support for compatible id's!

    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…)
      3 comments  ·  Others  ·  Flag idea as inappropriate…  ·  Admin →
    • 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 →
      • 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…)
          4 comments  ·  Others  ·  Flag idea as inappropriate…  ·  Admin →
        • 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…)
            2 comments  ·  Others  ·  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 - 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 →
              • 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 →
                • 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 →
                  • Posted location of API Terms of Use

                    I could not find the Terms of Use of the OneNote API.
                    Where do you posted it?

                    http://dev.onenote.com/

                    2 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  ·  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.

                      • POST Page Response Properties should return id of created page, not just application links

                        In order to maintain content of a page after it has been created it would be nice to get the page id back after it is created. Can search for page after it has been created by the page title with the new beta APIs, but page titles aren't guaranteed to be unique.

                        0 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  ·  Gareth JonesGareth Jones responded

                          This is already live in our BETA endpoint. Currently the rest of the APIs that involve retrieving or updating a page are still in BETA as well, but as soon as one of those is ready for production, we’ll also have the ID returned with any page created

                        • recent changes

                          In order to do any sensible line of business integration we would at least needs an API to get a list of recently added or modified pages with appropriate urls to get to the desired page etc...

                          e.g a user uploads via `Office Lens` -> a business application that the user authorizes all sections or individual sections (or notebooks) for access. then the uploaded document could be downloaded and imported into the line-of-business context.

                          7 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  ·  Gareth JonesGareth Jones responded

                            Today we released updated pages endpoint that queries by last modified time by default. You do still have to poll this, but hopefully it unblocks you?

                          • API's to allow OneNote to be used as a central data store for apps on multiple platforms

                            API's to allow OneNote to be used as a central data store for apps on multiple platforms and devices.

                            OneNote is already perfect for this as it is multi-platform and automatically sync'd to the cloud. But needs some things:
                            - Add pages to sections in a workbook that is not the default, and add section if it doesn't exist
                            - Update page content (see next
                            - Read page content, ideally in something like json. Maybe return tables as an array of json objects (where rows are objects and columns are object props)
                            - Delete notebooks in case creation of new…

                            41 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 →
                            • How to change the timestamp string format when I add a page by OneNote API ?

                              How to change the timestamp string format when I add a page by OneNote API ?
                              I have try to change the datetime string in meta, but It doesn't work ?
                              Who can help me ?

                              string date = page.CreateTime.ToString("yyyy-MM-dd HH:mm:ss");

                              <meta name=\"created\" content=\"" + date + "\" />

                              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  ·  Documentation  ·  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?

                                • How about just implementing a full OneNote Object Model bringing in line with the rest of the Office suite?

                                  Recently I tried to create a OneNote app to create workbooks from scanned pages so students could used the notebooks for coursework. Imagine my surprise when i found out that the API for OneNote not only barely supported anything - the sample code didn't work.

                                  I know OneNote is being separated from Office to a degree - but it's amazing that it has almost no capability to be automated.

                                  21 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  ·  Others  ·  Flag idea as inappropriate…  ·  Admin →
                                    Completed  ·  Gareth JonesGareth Jones responded

                                    As of today’s releases we’ve got a fairly rich surface. Please repurpose these votes to your next set of specific priorities.

                                  • API extensions to Create/Manage Notebooks/SectionGroups/Sections and Pages

                                    Being able to create notebooks with section groups, sections and pages and also to be able to remove/udpate them if necessary.

                                    7 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 →
                                    • 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 →
                                      • 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 →
                                        • 2 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  ·  Flag idea as inappropriate…  ·  Admin →
                                          ← Previous 1 3
                                          • Don't see your idea?

                                          OneNote Developer APIs

                                          Feedback and Knowledge Base