MRPeasy API

MRPeasy offers a REST API, available to paying clients on the Unlimited pricing plan. The API is designed for integrations and process automation rather than replacing the user interface.

The full API specification is available in OpenAPI JSON format here: https://api.mrpeasy.com/rest/v2/openapi.json. This specification provides a detailed overview of the available endpoints, request and response formats, authentication requirements, and supported objects.

Please note that the API is an Application Programming Interface and not a standard function of the MRPeasy software. Our Support Department does not provide assistance with API usage or development. To implement and use the API, you need your own qualified software development partner.

API version compatibility

The MRPeasy API v2 is currently in an early stage of development and will be expanded gradually with additional endpoints and functionality.

If a required endpoint or feature is not yet available in v2, please use the corresponding endpoint from the v1 API.

You can find the v1 API documentation here: https://mrpeasy.readme.io/v1.0/

We recommend using v2 for all newly available functionality, while relying on v1 endpoints where necessary during the transition period.