Redmine icon

Redmine

Consume Redmine API

Overview

This node integrates with the Redmine API to manage users, projects, and issues. Specifically, for the User - Get Many operation, it retrieves multiple user records from a Redmine instance. This is useful when you want to fetch lists of users for reporting, synchronization, or automation purposes.

Practical examples include:

  • Fetching all active users in a Redmine project to send notifications.
  • Retrieving a filtered list of users by group or status for access control audits.
  • Limiting the number of users returned to optimize performance in workflows.

Properties

Name Meaning
Return All Whether to return all matching users or limit the results. Options: true (all), false.
Limit Maximum number of users to return if not returning all. Must be at least 1.
Filters Collection of filters to narrow down the user list:
  Group ID Filter users by their group identifier (string).
  Name Filter users by name (string).
  Status Filter users by status. Options: Active, Registered, Locked.

Output

The node outputs an array of user objects in the json field. Each object represents a user retrieved from Redmine, containing typical user details such as ID, name, status, group membership, and other relevant metadata as provided by the Redmine API.

No binary data output is produced by this operation.

Dependencies

  • Requires connection to a Redmine instance via its REST API.
  • Needs an API key credential for authentication.
  • The node expects the Redmine base URL and API key to be configured in the credentials.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API key will cause authentication failures.
    • Invalid base URL or network issues can prevent connecting to Redmine.
    • Using filters with incorrect values may result in empty responses.
    • Setting Return All to false but not specifying a valid Limit could lead to unexpected results.
  • Error Messages:

    • Authentication errors typically indicate invalid API keys or insufficient permissions.
    • Network errors suggest connectivity problems or wrong URLs.
    • Validation errors may occur if filter parameters are malformed.

To resolve these:

  • Verify API key correctness and permissions.
  • Confirm the Redmine URL is reachable and correct.
  • Double-check filter values and types.
  • Use the Return All option carefully to avoid large data loads.

Links and References

Discussion