Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Redmine Java API

Deprecated getCustomField() method in Issue because its return value …

…is confusing.

Removed hardcoded Custom Field IDs from IssueManagerTest - those tests started to fail
when I re-created custom field definitions on the test server.

Redmine/Chiliproject Java API.

  • Uses Redmine's REST API (don't forget to enable it in Redmine server settings).
  • Does not require any plugins installed on Redmine/Chiliproject server.
  • Runs on any standard Java 6+ platform.
  • Supports HTTP proxy
  • Supports GZipped responses from servers
  • Uses SLF4J for logging. Provide your own SLF4J binding
  • Supported Redmine versions
  • Available in Maven Central.

Gradle dependency:

dependencies {
    compile 'com.taskadapter:redmine-java-api:2.1.0'

Check the latest release version in Maven Central

Sample code.

Sample code to retrieve list of Redmine issues:

String uri = "";
String apiAccessKey = "a3221bfcef5750219bd0a2df69519416dba17fc9";
String projectKey = "taskconnector-test";
Integer queryId = null; // any

RedmineManager mgr = RedmineManagerFactory.createWithApiKey(uri, apiAccessKey);
List<Issue> issues = mgr.getIssueManager().getIssues(projectKey, queryId);
for (Issue issue : issues) {

How to contribute to the project.

  • Install Gradle 2.1+.
  • To build in command line: run "gradle build".
  • To open the project code in IDEA or Eclipse: open "build.gradle" file. Your IDE will create a project from the gradle script.
  • Please make sure you add unit and/or integration tests when submitting your changes. Don't forget to document required Redmine version and other limitations & requirements.
Something went wrong with that request. Please try again.