Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node interacts with the Paperless NGX API to retrieve information about document types. Specifically, the "Get" operation for the "Document Type" resource allows users to fetch one or multiple document types from the system. This is useful in scenarios where you want to list available document types, filter them by various criteria, or get detailed permission information.

Practical examples include:

  • Fetching a paginated list of document types to display in a UI.
  • Filtering document types by name patterns (e.g., all document types starting with "Invoice").
  • Retrieving full permission details for document types to manage access control.

Properties

Name Meaning
Note Informational note: Owner and permissions fields accept numeric IDs. Users and Groups can be retrieved using the provided nodes.
Page Page number to retrieve (for pagination).
Page Size Number of items to return per page (pagination size).
Sort By Field name to sort the results by.
Document Type ID The unique numeric ID of the document type to get. Required when fetching a specific document type.
Full Permissions Boolean flag indicating whether to include full permission information in the response.
Filter by IDs Comma-separated list of document type IDs to filter the results by.
Name Contains Filter document types whose names contain this text (case-insensitive).
Name Ends With Filter document types whose names end with this text (case-insensitive).
Name Exact Match Filter document types whose names exactly match this text (case-insensitive).
Name Starts With Filter document types whose names start with this text (case-insensitive).

Output

The output JSON contains the retrieved document type(s) data as returned by the Paperless NGX API. This typically includes fields such as the document type's ID, name, description, and optionally permission details if requested.

If multiple document types are fetched (e.g., via pagination or filtering), the output will be an array of document type objects.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Paperless NGX API.
  • The node expects the base URL of the Paperless NGX instance to be configured in the credentials.
  • No other external dependencies are required.

Troubleshooting

  • Common issues:

    • Invalid or missing API authentication token will cause authorization errors.
    • Requesting a document type ID that does not exist will likely result in a "not found" error.
    • Providing invalid filter parameters (e.g., malformed comma-separated IDs) may cause request failures.

  • Error messages:

    • Authorization errors: Ensure the API key credential is correctly set up and has sufficient permissions.
    • Not found errors: Verify the document type ID exists before requesting.
    • Validation errors: Check that numeric fields (like IDs, page, page size) are valid numbers.

Links and References

Discussion