OpenProject icon

OpenProject

Consume OpenProject API
Join our community

Actions43

Overview

This node interacts 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 Status resource with the Get All operation, it retrieves a list of status records from OpenProject.

Common scenarios where this node is beneficial include:

  • Fetching all available statuses to display in a dropdown or selection UI.
  • Synchronizing status data from OpenProject into another system.
  • Reporting or analytics that require status information.

For example, you might use this node to get all statuses filtered by a certain condition (e.g., only open statuses), sorted by creation date, or grouped by a specific field.

Properties

Name Meaning
Options A collection of optional parameters to customize the query:
- Limit Max number of results to return (minimum 1).
- Offset Number of results to skip (minimum 0).
- Filter Filter results by specific fields using a simple field=value syntax (e.g., status=open).
- Sort By Sort results by a field and direction (e.g., created_at:desc).
- Select Fields Comma-separated list of 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 data retrieval to match your needs.

Output

The node outputs an array of JSON objects representing the retrieved statuses. Each object corresponds to a status record returned by the OpenProject API and includes fields as specified by the Select Fields option or the default API response.

The output structure is:

[
  {
    "json": {
      // Status fields, e.g.:
      "id": "123",
      "name": "Open",
      "status": "active",
      ...
    }
  },
  ...
]

No binary data is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The node expects the base URL of the OpenProject instance and the API key to be configured in the credentials.
  • Uses HTTP Basic Authentication with the API key encoded in Base64.
  • Relies on the OpenProject REST API v3 endpoints.

Troubleshooting

  • Error: The resource 'status' is not supported!
    This indicates an invalid resource parameter; ensure "Status" is selected as the resource.

  • Error: OpenProject error response: [message]
    This means the OpenProject API returned an error message. Common causes include invalid filters, incorrect API key, or insufficient permissions. Verify your credentials and filter syntax.

  • Empty results or missing fields
    Check if the Filter, Select Fields, or Group By options are correctly set. Incorrect filters may exclude all results.

  • Authentication failures
    Ensure the API key credential is valid and has sufficient rights to access statuses.

  • Network or connectivity issues
    Confirm the base URL is reachable from n8n and no firewall blocks the connection.

Links and References

Discussion