OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node operation lists groups from an OpenProject instance. It is useful for retrieving collections of user groups, which can be used to manage permissions, organize users, or integrate group data into workflows. For example, you might use this node to fetch all groups sorted by creation date to display in a dashboard or to synchronize group information with another system.

Properties

Name Meaning
Sort By JSON string specifying the sort criteria for the returned groups. Supported fields include id (primary key), created_at (group creation datetime), and updated_at (last update time). Example: [["id", "asc"]].
Select Comma-separated list of properties to include in the response. Common values are total, elements/name, elements/self, and self. This controls which group attributes are returned by the API call.

Output

The output contains a JSON object representing the list of groups retrieved from the OpenProject API. The structure includes:

  • total: Total number of groups available.
  • elements: An array where each element represents a group, typically including its name and a self link (URL to the group resource).
  • self: A URL pointing to the current query result.

No binary data is output by this node.

Dependencies

  • Requires an active connection to an OpenProject instance via its REST API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The node uses standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Invalid Sort Criteria: If the Sort By JSON is malformed or uses unsupported fields, the API may return an error or no results. Ensure the JSON is valid and only uses supported sort keys (id, created_at, updated_at).
  • Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify that the API key/token is correctly set up in the node credentials.
  • Empty Results: If no groups are returned, check if the OpenProject instance actually has groups created or if the Select property filters out all fields.
  • API Endpoint Issues: Network problems or incorrect base URL configuration can prevent successful API calls. Confirm the OpenProject URL is reachable and correct.

Links and References

Discussion