Leveraging the REST API

The REST API is a powerful interface to Paperless-ngx offering near endless possibilities.

Prerequisites

Create an API token. If you like, you can create an dedicated technical user for your API scripts.

Examples

Have a look at the examples via the navigation on the left side.

The content matching post-consumption script is using the API as well.