This is an old revision of the document!
It provides a REST API interface to phpList.
This is the continuation of the original REST API plugin by Andreas Ek
If you use this plugin, please sign up to the phpList RestAPI list so that you can be informed of changes.
IMPORTANT: If you have used the API previous to November 2015, you will need to be careful to upgrade to the latest version. A lot has changed in the API, and if you make calls on the old API, they are likely to fail.
The previous version is available on https://github.com/phpList/phplist-plugin-restapi/archive/stable.zip
Once the plugin is installed, three plugins will list in the “Manage Plugins” page.
The current plugin is the one called restapi and you need to switch it on to use it.
The other two plugins are unstable and in development
The plugin is CI tested on https://travis-ci.org/phpList/phplist-plugin-restapi
The phpUnit tests give examples of how to use the API
Further examples in PHP, and an example Client class, can be found at https://github.com/michield/phplist-restapi-client. Please fork and update the client.
The plugin will add the following entries to the Settings page of phpList
The current state of the plugin allows for simple calls to manipulate lists, subscribers, campaigns and templates.
Future developments will go towards a joint effort of the phpList4 project and the phpList RESTAPI plugin. Work on this has already started in the “restapi2” part of this plugin, but is still in progress.