REST API

Warning

REST API described here is work in progress. It changes along with the development of Papermerge Core in master branch.

REST API is the main interface with Papermege backend server. This basically means that whataver capabilities backend features, they can be consumed via REST API.

REST API first approach gives you power to automate your documents workflows in unlimited ways.

Following sections describe in detail how to use REST API and provide a reference (with examples) for each existing endpoint.

• Overview
  • Server URL + Prefix
• Authentication
• Auth-token
• Users
  • GET /users/
  • POST /users/
  • GET /users/{id}/
  • DELETE /users/{id}/
  • PATCH /users/{id}/
  • POST /users/{id}/change-password/
  • GET /users/me/
• Nodes
  • GET /nodes/{id}/
  • POST /nodes/
  • POST /nodes/move/
  • GetNodeFolderAttrs
  • GetNodeDocumentAttrs
  • PostNodeFolderAttrs
  • PostNodeDocumentAttrs
• Folders
• Documents
• Search
  • GET /search/
• Preferences
  • GET /preferences/
  • GET /preferences/{section__name}/
  • PATCH /preferences/{section__name}/
  • POST /preferences/bulk/
  • Boolean Type
  • Choices Type
  • Char Type