Does Joplin Server have a public HTTP API?

Support
1

Operating system

Linux

Joplin version

3.4.2

Sync target

Joplin Server

What issue do you have?

I have setup a Joplin Server on PikaPods, and would like to access certain notes in it to display on a website. Does Joplin Server have an HTTP API that we can access publicly? Or is the 'data api' mentioned in the docs only available on the client?

Any guidance would be greatly appreciated.

2

Yes, but it's undocumented. I added experimental support in joppy.

Yes, that's only available in a Joplin client.

3

Thank you for the info, and for developing such a valuable addition to Joplin, @Marph !

Did I read in that Joppy thread that there is currently an official project to eventually add an API to the server directly?

1 Like
4

There is a project, but I'm not sure about its state: Standalone Sync API - Joplin Forum

Maybe @khuongduy354 has some insights about it.

5

The Joplin Server don't have public docs for API as I remembered. Regarding my project, yes, it can access Joplin Server directly, it was intended for CRUD operations with sync awareness, but very experimental at the moment (I paused it for a very long time because of no solid use cases and some personal matters). For now, you can use READ-ONLY operations:

I'm intending to review it in near future, for a smaller scope regarding Web Clipper project. You can DM me if you have any questions :smiley:.

Thanks @Marph for mentioning me, your joppy project looks cool, I’ll look into it while reviewing my sync lib.

1 Like
6

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.