Easy8 API Specification

Introduction

Easy8 includes a powerful API that allows you to integrate it with other applications. The API covers most entities in the system and supports various operations. This article explains where and how to access the API specification directly within your Easy8 environment.

Target Audience

Administrator

Understanding Easy8 API Access

Definition

Easy8 provides an interactive API documentation tool known as Easy Swagger. It is available by default from version 10.14 LTS and higher. The tool includes all available API endpoints and allows developers to test requests directly within the browser.

How It Works

You can access your API specification through the following URL:

[your_easy_redmine_url]/easy_swagger

For example:

https://easyredmine.company.com/easy_swagger

The page loads a full, interactive list of supported API endpoints. It also shows parameters, responses, and request methods. You can try out real API calls directly on this page.

Caution: Avoid testing write operations on production environments. The Swagger interface uses real data and may cause unintended changes.

External Access (Trial or Demo)

If you don’t have your own Easy8 instance yet, you can still explore the API documentation at:

https://app.swaggerhub.com/apis-docs/easysoftware/EasyProject/

This is a public read-only version of the API documentation.

Troubleshooting

If visiting /easy_swagger results in a 404 error:

Go to Administration → Plugins
Find the plugin called Swagger
Click Edit
Make sure the plugin is activated

Once activated, reload the page to access the documentation.

Examples

Some entities typically available through the API:

Tasks
Projects
Users
Time entries
Custom fields
Attachments

With the API, you can build integrations to automate workflows or connect Easy8 to CRMs, ERPs, or other tools.

Conclusion

Easy8’s API is a flexible and accessible tool for integration with other systems. Thanks to Easy Swagger, developers can browse and test the API quickly and safely. Always use a test environment when experimenting with live commands to avoid affecting production data.