OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node operation allows you to list documents from the OpenProject system. It is useful for retrieving paginated lists of documents with control over sorting and pagination parameters. Typical use cases include displaying document lists in dashboards, exporting document metadata, or integrating document data into other workflows.

For example, you might use this node to fetch the first 25 documents sorted by creation date ascending, then process or display them elsewhere.

Properties

Name Meaning
Offset Page number inside the requested collection. Used to paginate through the list of documents.
Page Size Number of elements to display per page. Controls how many documents are returned in one request.
Sort By JSON string specifying sort criteria. Accepts an array with fields and directions. Supported fields: id, created_at.

Output

The output contains a JSON array of document objects retrieved from OpenProject according to the specified pagination and sorting options. Each object represents a document with its associated metadata as provided by the OpenProject API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The node uses the OpenProject REST API endpoint configured via credentials (base URL).
  • No additional external dependencies beyond the OpenProject API and n8n's HTTP request capabilities.

Troubleshooting

  • Empty results: Check that the offset and page size values are within valid ranges and that documents exist in the project.
  • Invalid sortBy format: Ensure the Sort By property is a valid JSON string representing an array of arrays, e.g., [["created_at", "asc"]].
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions to access documents.
  • API connectivity issues: Confirm the base URL is correct and reachable from your n8n instance.

Links and References

Discussion