plone.restapi: A RESTful hypermedia API for Plone.


plone.restapi is a RESTful hypermedia API for Plone.

Getting started

A live demo of Plone 5 with the latest plone.restapi release is available at:

Example GET request on the portal root

curl -i -H "Accept: application/json"

Example POST request to create a new document

curl -i -X POST -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"@type": "Document", "title": "My Document"}' --user admin:admin


You will need some kind of API browser application to explore the API. We recommend using Postman.


Install plone.restapi by adding it to your buildout:



eggs =

and then running bin/buildout


plone.restapi is used in production since the first alpha release. It can be seen in action at the following sites:


If you are having issues, please let us know via the issue tracker.

If you required professional support, here is a list of Plone solution providers that contributed significantly to plone.restapi in the past:


The project is licensed under the GPLv2.

Appendix, Indices and tables