OneNote Developer APIs

Update: Microsoft will be moving away from UserVoice sites on a product-by-product basis throughout the 2021 calendar year. We will leverage 1st party solutions for customer feedback. Learn more

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.


  1. API to delete page content

    There is no way to delete some content from a page with the API. Such as in this example:

    <body>

    &lt;div id=&quot;div:{681ddef6-e8ad-0de3-2439-dcc668303696}{34}&quot;&gt;
    
    &lt;p id=&quot;p:{f5837c83-d816-4337-ab6d-a52abde869a6}{13}&quot;&gt;Delete me&lt;/p&gt;
    &lt;p id=&quot;p:{1710a020-7fa3-46cb-a8ab-64209696e083}{14}&quot;&gt;Keep me/p&gt;
    &lt;/div&gt;

    </body>

    We should be able to have a PATCH request with the following instruction:
    [{
    'target': 'p:{f5837c83-d816-4337-ab6d-a52abde869a6}{13}',
    'action': 'delete',
    },
    ]

    9 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  2. Ability to reorder page

    Ability to set order of the page created and reorder of the pages would be useful

    47 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    3 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  3. Custom data attributes (data-custom-*) per element

    Support for data-* attributes with custom names would be great.

    It would allow keeping 3rd party application specific metadata along elements. This would enhance sync possibilites with external systems.

    These attributes would be not interpreted by OneNote but persisted. Now I tested it and these attributes are thrown away when doing roundtrip via OneNote API.

    Currently, there is only data-id attribute which is great but not offering much flexibility.

    These new attribute could have extra prefix e.g. data-custom-* not to collide with your internal attributes..

    8 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  4. Section & page ordering: matching desktop versions

    To improve the user experience can the API please allow us to order section and pages to match what the user's desktop client ordering is? Or at least provide an orderby option for this?

    I assume that this information is available? I don't have to re-order all my information on iOS client or desktop client if I install from scratch. The OneNote web client knows the order of sections & pages. Can the API too please

    12 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  5. Document Auth so that a service application can sign in using static credentials

    Its common to want to build a service application (native) that can access the API using a fixed credential without UI intervention. This looks possible, but there is no sample demonstrating this, or article on how to do it. Iv'e spent considerable time trying to guess how, but an example that works would help considerably

    6 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  6. Ability to POST(create) multiple sections at once and/or determine section order

    When creating multiple Notebooks with multiple default sections a huge number of requests are required. Even using curlmutliexec it seems time consuming. The order the sections end up being displayed is fairly random as well via this approach.

    8 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    2 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  7. get page content should return lists as items in LI tags

    Get page content does not return multi level lists but only flat paragraphs. The level of indentation is lost that way. The API should either return HTML lists or add that information to the attributes of the paragraphs.

    13 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    2 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  8. Add Dictionnary

    I am pretty sure I'm not the only one, who would REALLY like to have a dictionary in One Note. At least in English, French, Spanish and Chinese for starting, but something, please.

    10 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    2 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  9. Add an API to create SectionGroups

    Currently its possible to create Notebooks, Sections and Pages through the REST API. Please add SectionGroup creation to round out the core OneNote hierarchy types.

    18 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    started  ·  1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  10. Make page modified times update immediately in the API

    Currently, it takes a long time (seems like 20 minutes to an hour is common) for the ModifiedDate of a page to be reflected in the API after a user makes a change. Meanwhile, the containing Section has its ModifiedDate updated immediately. This is very strange behavior. It also seems like sometimes only the section's ModifiedDate ever changes, even though I'm clearly adding text to a page.

    Since there's no notification mechanism in the OneNote API, my current solution is to poll for changes (to update our Slack channel), but this has unexpected delays and reliability problems due to the…

    6 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    started  ·  0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  11. 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.

    34 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  12. Ink support in the API

    Be able to support something like InkML in OneNote pages through the API.

    125 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    15 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  13. API to let me share a notebook with someone

    Just like how a user share a notebook with one or more other users, I want to be able to do this programmatically.

    111 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    7 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  14. 22 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
    started  ·  Gareth Jones responded

    We recently shipped beta SDKs for iOS and Android for OneNote on github.

  15. 19 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  16. When PDF rendering is added, make the text available to the developer!

    When you do add the feature to render a PDF document directly into the note itself, please make the PDF text accessible to the developer. This would enable a huge, exciting new class of apps based on the OneNote API.

    21 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    1 comment  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  17. Documentation on how to create and update nested lists in onenote pages.

    Currently I cant get nested lists to be updated or created. Can you please provide better documentation.

    1 vote
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  18. BUG: REST API - MathML is repeated throughout a page

    When retrieving a page with MathML content, the math tags are repeated for every equation. The first instance is in the correct position, and the second is usually at the end.

    3 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  19. insert sharepoint form in onenote

    Hi,
    I would like to create fields in OneNote page who would inform a SharePoint Library.

    9 votes
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  20. Get/Put RAW page data

    Hi,

    I want to get and put the raw data for a page, so that I don't have to parse the HTML rendered page and download the resources, and maybe have to wait for another API for supporting Ink or other extension generated data. And I'd like to avoid generate multipart http request just to restore what I downloaded.

    And want this integrated to MS GRAPH API C# DLL so that I don't have to create raw http(s) request.

    1 vote
    Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    You have left! (?) (thinking…)
    0 comments  ·  REST API  ·  Flag idea as inappropriate…  ·  Admin →
  • Don't see your idea?

OneNote Developer APIs

Categories

Feedback and Knowledge Base