OpenProject icon

OpenProject

Consume OpenProject API
Join our community

Actions43

Overview

This node integrates with the OpenProject API to manage various resources such as projects, users, work packages, time entries, versions, types, statuses, priorities, and categories. Specifically, for the User resource with the Get All operation, it retrieves a list of users from an OpenProject instance.

Common scenarios where this node is beneficial include:

  • Automating user management workflows by fetching all users in an OpenProject system.
  • Synchronizing user data between OpenProject and other systems.
  • Reporting or auditing user information programmatically.

For example, you could use this node to get all users filtered by status or sorted by creation date, then process or export that data elsewhere.

Properties

Name Meaning
Options Collection of optional parameters to customize the query:
- Limit Max number of user results to return (minimum 1).
- Offset Number of user results to skip (minimum 0).
- Filter Filter results by specific fields using field=value syntax (e.g., status=open).
- Sort By Sort results by field and direction (e.g., created_at:desc).
- Select Fields Comma-separated list of user fields to include in the response (e.g., id,name,status).
- Group By Group results by a specific field (e.g., status).

These options allow fine-tuning the retrieval of users according to your needs.

Output

The node outputs an array of JSON objects, each representing a user resource retrieved from OpenProject. The structure corresponds directly to the OpenProject API's user representation, including fields such as user ID, name, email, login, and any other selected fields.

No binary data output is produced by this operation.

Example output snippet (simplified):

{
  "id": "123",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "status": "active"
}

Dependencies

  • Requires an active OpenProject instance accessible via its REST API.
  • Needs an API key credential configured in n8n for authentication.
  • Uses HTTP Basic Authentication with the API key encoded in the header.
  • Relies on the axios library for making HTTP requests.

Troubleshooting

  • Common issues:

    • Incorrect or missing API key credential will cause authentication failures.
    • Invalid filter or sort syntax may result in API errors.
    • Network connectivity problems to the OpenProject server.
    • Requesting unsupported fields in Select Fields can cause errors.

  • Error messages:

    • OpenProject error response: <message> indicates an error returned by the OpenProject API, often due to invalid parameters or permissions.
    • Generic network or request errors will show the underlying message from axios.

  • Resolutions:

    • Verify the API key and base URL configuration.
    • Ensure filters and sorting strings follow the expected format.
    • Check network access to the OpenProject server.
    • Confirm requested fields exist in the OpenProject user schema.

Links and References

Discussion