This is the documentation for version 2.1 of the Church of England CMS API.
The CMS API v2.1 allows communication with the CMS database via RESTful API calls. It is a restricted API and requires suitable approval before access it granted. Please contact your Diocesan office to request access credentials.
All responses from the CMS API are in JSON format.
Released June 2023
The following new endpoints have been added to the CMS API in this minor version update:
Released November 2016
Version 2 of the CMS API brings forth a number of improvements and new functionality that have been developed based on the feedback of version 1 users.
This includes:
EOL 25th July 2019
We wish to inform you that it has been decided to set the API V1 End of Life to 11th January 2019. All existing users of API v1 are recommend to make plans soon, to switch to API v2 before this time.
Please note: due to the request of a couple of users, we have kept the API V1 running for several months after the planned switch off date. However, version 1 will be switched off from 25th July 2019 and this date is now final.
Version 1 will remain operational until 11th January 2019, we would strongly suggest that version 1 users upgrade to version 2 of the API as soon as is feasible due to the number of improvements and additional functionality version 2 introduces.
From this point forward, no further API credentials for version 1 shall be issued.