self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2026-06-18 20:16:34 +02:00
Code Issues Releases Activity

Doc: Auto-update documentation

Browse Source 
Auto-updated using release-website.sh
This commit is contained in:
Joplin Bot
2024-02-26 12:19:13 +00:00
parent 64684dc896
commit c2e49ebb2b
2 changed files with 245 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme/api/references/rest_api.md
+3 -3
View File
@@ -21,7 +21,7 @@ for (let portToTest = 41184; portToTest <= 41194; portToTest++) {
## Authorisation
To prevent unauthorised applications from accessing the API, the calls must be authentified. To do so, you must provide a token as a query parameter for each API call. You can get this token from the Joplin desktop application, on the Web Clipper Options screen.
To prevent unauthorised applications from accessing the API, the calls must be authenticated. To do so, you must provide a token as a query parameter for each API call. You can get this token from the Joplin desktop application, on the Web Clipper Options screen.
This would be an example of valid cURL call using a token:
@@ -101,7 +101,7 @@ Then you will resume fetching the results using this query:
curl http://localhost:41184/notes?order_by=updated_time&order_dir=ASC&limit=10&page=2
```
Eventually you will get some results that do not contain an "has_more" paramater, at which point you will have retrieved all the results
Eventually you will get some results that do not contain an "has_more" parameter, at which point you will have retrieved all the results
As an example the pseudo-code below could be used to fetch all the notes:
@@ -146,7 +146,7 @@ To retrieve all the tags that start with `project-`: **GET /search?query=project
## Item type IDs
Item type IDs might be refered to in certain object you will retrieve from the API. This is the correspondance between name and ID:
Item type IDs might be referred to in certain objects you will retrieve from the API. This is the correspondence between name and ID:
Name | Value
---- | -----