[GH-ISSUE #626] api doc link broken #492

Closed
opened 2026-02-25 21:32:02 +03:00 by kerem · 1 comment
Owner

Originally created by @WolfgangFahl on GitHub (Aug 24, 2024).
Original GitHub issue: https://github.com/ciur/papermerge/issues/626

Originally assigned to: @ciur on GitHub.

The link in https://papermerge.com/pages/rest-api
https://docs.papermerge.io/REST%20API/index.html

is broken. The result should be more like below:

Papermerge DMS API Endpoints

Users

Method Endpoint Description
GET /users/me Get Current User
GET /users/ Get Users
POST /users/ Create User
DELETE /users/{user_id} Delete User
PATCH /users/{user_id} Update User

Nodes

Method Endpoint Description
GET /nodes/ Get Nodes
POST /nodes/ Create Node
DELETE /nodes/ Delete Nodes
GET /nodes/{parent_id} Get Node
PATCH /nodes/{node_id} Update Node
POST /nodes/move Move Nodes
POST /nodes/{node_id}/tags Assign Node Tags
PATCH /nodes/{node_id}/tags Update Node Tags
DELETE /nodes/{node_id}/tags Delete Node Tags

Folders

Method Endpoint Description
GET /folders/{folder_id} Get Node

Documents

Method Endpoint Description
GET /documents/{document_id} Get Document Details
POST /documents/{document_id}/upload Upload File

Document Versions

Method Endpoint Description
GET /document-versions/{document_version_id}/download Download Document Version

Pages

Method Endpoint Description
GET /pages/{page_id}/svg Get Page Svg Url
GET /pages/{page_id}/jpg Get Page Jpg Url
POST /pages/ Apply Page Operations
POST /pages/move Move Pages
POST /pages/extract Extract Pages

Thumbnails

Method Endpoint Description
GET /thumbnails/{document_id} Retrieve Document Thumbnail

Tags

Method Endpoint Description
GET /tags/ Retrieve Tags
POST /tags/ Create Tag
DELETE /tags/{tag_id} Delete Tag
PATCH /tags/{tag_id} Update Tag

Tasks

Method Endpoint Description
POST /tasks/ocr Start OCR

OCR Languages

Method Endpoint Description
GET /ocr-languages/ Get OCR Langs

Version

Method Endpoint Description
GET /version/ Get Version
Method Endpoint Description
GET /search/ Search
Originally created by @WolfgangFahl on GitHub (Aug 24, 2024). Original GitHub issue: https://github.com/ciur/papermerge/issues/626 Originally assigned to: @ciur on GitHub. The link in https://papermerge.com/pages/rest-api https://docs.papermerge.io/REST%20API/index.html is broken. The result should be more like below: # Papermerge DMS API Endpoints ## Users | Method | Endpoint | Description | |--------|----------------------------|-------------------| | GET | /users/me | Get Current User | | GET | /users/ | Get Users | | POST | /users/ | Create User | | DELETE | /users/{user_id} | Delete User | | PATCH | /users/{user_id} | Update User | ## Nodes | Method | Endpoint | Description | |--------|----------------------------|---------------------| | GET | /nodes/ | Get Nodes | | POST | /nodes/ | Create Node | | DELETE | /nodes/ | Delete Nodes | | GET | /nodes/{parent_id} | Get Node | | PATCH | /nodes/{node_id} | Update Node | | POST | /nodes/move | Move Nodes | | POST | /nodes/{node_id}/tags | Assign Node Tags | | PATCH | /nodes/{node_id}/tags | Update Node Tags | | DELETE | /nodes/{node_id}/tags | Delete Node Tags | ## Folders | Method | Endpoint | Description | |--------|----------------------------|---------------------| | GET | /folders/{folder_id} | Get Node | ## Documents | Method | Endpoint | Description | |--------|----------------------------|-------------------------| | GET | /documents/{document_id} | Get Document Details | | POST | /documents/{document_id}/upload | Upload File | ## Document Versions | Method | Endpoint | Description | |--------|----------------------------------------------------|-----------------------------| | GET | /document-versions/{document_version_id}/download | Download Document Version | ## Pages | Method | Endpoint | Description | |--------|----------------------------|-----------------------| | GET | /pages/{page_id}/svg | Get Page Svg Url | | GET | /pages/{page_id}/jpg | Get Page Jpg Url | | POST | /pages/ | Apply Page Operations | | POST | /pages/move | Move Pages | | POST | /pages/extract | Extract Pages | ## Thumbnails | Method | Endpoint | Description | |--------|------------------------------|--------------------------------| | GET | /thumbnails/{document_id} | Retrieve Document Thumbnail | ## Tags | Method | Endpoint | Description | |--------|----------------------------|-------------------| | GET | /tags/ | Retrieve Tags | | POST | /tags/ | Create Tag | | DELETE | /tags/{tag_id} | Delete Tag | | PATCH | /tags/{tag_id} | Update Tag | ## Tasks | Method | Endpoint | Description | |--------|----------------|-------------------| | POST | /tasks/ocr | Start OCR | ## OCR Languages | Method | Endpoint | Description | |--------|---------------------|-------------------| | GET | /ocr-languages/ | Get OCR Langs | ## Version | Method | Endpoint | Description | |--------|----------------|-------------------| | GET | /version/ | Get Version | ## Search | Method | Endpoint | Description | |--------|----------------|-------------------| | GET | /search/ | Search |
kerem 2026-02-25 21:32:02 +03:00
  • closed this issue
  • added the
    bug
    label
Author
Owner

@ciur commented on GitHub (Sep 14, 2025):

Closing Note:

The REST API link referenced in this ticket is outdated.
The current REST API documentation is here: https://demo.papermerge.com/docs

Closing this ticket as obsolete.

<!-- gh-comment-id:3289171315 --> @ciur commented on GitHub (Sep 14, 2025): **Closing Note:** The REST API link referenced in this ticket is outdated. The current REST API documentation is here: https://demo.papermerge.com/docs Closing this ticket as obsolete.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/papermerge#492
No description provided.