OpenProject icon

OpenProject

Consume OpenProject API

Overview

This node integrates with the OpenProject API, allowing users to perform various operations on OpenProject resources such as projects, users, work packages, time entries, versions, types, statuses, priorities, and categories. Specifically, for the Project resource with the Get operation, the node retrieves detailed information about a single project by its ID.

Common scenarios where this node is beneficial include:

  • Fetching project details to display or use in workflows.
  • Automating project management tasks by retrieving project metadata.
  • Integrating OpenProject data into other systems or reports.

For example, you can use this node to get the full details of a project by providing its Project ID, then use that data downstream in your workflow to update dashboards or trigger notifications.

Properties

Name Meaning
Project ID The unique identifier of the project to retrieve. This is required to specify which project’s details to fetch.

Output

The node outputs an array of JSON objects, each representing the response from the OpenProject API for the requested project. The json output field contains the full project data as returned by the API, including all available fields such as project name, description, status, identifiers, and related metadata.

No binary data is output by this operation.

Example output structure (simplified):

{
  "id": "123",
  "name": "Example Project",
  "identifier": "example-project",
  "description": "A sample project description",
  "status": "active",
  // ... other project fields ...
}

Dependencies

  • Requires an active connection to the OpenProject API.
  • Needs an API key credential configured in n8n for authentication.
  • The base URL of the OpenProject instance must be provided in the credentials.
  • Uses HTTP Basic Authentication with the API key encoded in Base64.

Troubleshooting

  • Invalid Project ID: If the provided Project ID does not exist or is incorrect, the node will return an error indicating the resource was not found.
  • Authentication Errors: If the API key or base URL is misconfigured, the node will throw an authentication error. Verify the API key and endpoint URL in the credentials.
  • Unsupported Resource or Operation: Attempting to use unsupported combinations of resource and operation will result in errors specifying the unsupported action.
  • API Rate Limits or Network Issues: Network failures or rate limiting by the OpenProject API may cause request failures. Check network connectivity and API usage limits.

Error messages from the OpenProject API are surfaced clearly, e.g., "OpenProject error response: <message>", helping identify issues quickly.

Links and References

Discussion