OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

The "List News" operation of the News resource fetches a paginated list of news items from an OpenProject instance via its API. This node is useful for retrieving updates, announcements, or news entries related to projects managed in OpenProject. Typical use cases include displaying recent news on dashboards, aggregating project updates, or automating notifications based on news content.

For example, you could use this node to:

  • Retrieve the latest news items sorted by creation date.
  • Filter news to only those related to specific projects.
  • Paginate through large sets of news entries to process or display them incrementally.

Properties

Name Meaning
Offset Page number inside the requested collection. Used to skip a certain number of news items for pagination purposes.
Page Size Number of elements to display per page. Controls how many news items are returned in one request.
Sort By JSON string specifying sort criteria. Accepts sorting by id (primary key) or created_at (news creation datetime). Example: [["created_at", "asc"]] sorts news by creation date ascending.
Filters JSON string specifying filter conditions. Currently supports filtering news by project_id. Example: [{"project_id": {"operator": "=", "values": ["1", "2"]}}] filters news belonging to projects with IDs 1 or 2.

Output

The node outputs a JSON array of news items matching the specified criteria. Each item typically contains fields such as the news ID, creation date, title, description, and associated project information. The exact structure depends on the OpenProject API response for news.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to an OpenProject instance.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The base URL of the OpenProject API must be set in the credentials configuration.

Troubleshooting

  • Invalid JSON in Sort By or Filters: Since these properties expect JSON strings, malformed JSON will cause errors. Ensure valid JSON syntax when entering these values.
  • Authentication Errors: If the API key or URL is incorrect or missing, the node will fail to connect. Verify credential settings.
  • Pagination Issues: Setting offset or page size incorrectly may result in empty responses or repeated data. Adjust these values carefully.
  • Unsupported Filter or Sort Fields: Only certain fields (id, created_at for sorting; project_id for filtering) are supported. Using unsupported fields will likely cause API errors.

Links and References

Discussion