Churches and charities wishing to develop custom applications and website integrations can use the ChurchSuite developer API. Using an API key (that we provide on request), custom applications and integrations can interact securely with the data in your ChurchSuite modules.
Requests for API keys must come from your organisation's designated Account Contact. We also provide an OAuth endpoint for using the API as a specific Contact with limited access. However, the use of the embed endpoints is unrestricted.
API access is only available to customers subscribing to the full suite of modules. Developers without a ChurchSuite account and customers who do not currently subscribe to all modules are unable to make use of the API.
API access requires an Administrator to create an API User account that will be used specifically and only for API usage. The API User account should only have those module and site permissions required for the API application to function. API access should never piggyback another user's regular ChurchSuite usage.
ChurchSuite's latest API documentation can be found here. As we are constantly developing ChurchSuite our API documentation will always be in flux; therefore, we recommend you choose to "watch this project" if you plan to use the API. Regrettably, we cannot warrant that the changes we may make from time to time will not impact or break a previously-built application.
The following modules currently have documented API Endpoints: -
- Address Book
- Small Groups
API access is not currently possible for the Attendance, Rotas, Giving, Planning, Bookings or Networks modules.