The ChurchSuite API requires users to use a valid API key in order to interact with the data stored in their ChurchSuite account. Currently API Keys must be requested via support (support@churchsuite.com), we also provide an OAuth endpoint for using the API as a specific Contact with limited access. However use of the embed endpoints is not restricted.
To access the API each request must be accompanied by a X-Account header, a X-Application header and a X-Auth header, as of Dec 2013 requests missing any of these will not succeed. Additionally, the Content-Type header must be set to application/json. For example:
Content-Type: application/json
X-Account: demo
X-Application: Example
X-Auth: 1234567890abc
The ChurchSuite API is available at https://api.churchsuite.com/v1 and should always be accessed via SSL.
X-Accountrefers to the subdomain of your ChurchSuite Account (demo.churchsuite.com)X-Applicationis an identifier used to describe your application, e.g., yourchurch-websiteX-Authis an API Key, obtained either via OAuth or from Support.
The API is structured in the same way as the main ChurchSuite Application, with each model belonging to it's own module. For example a contact would be at the endpoint:
https://api.churchsuite.com/v1/addressbook/contact/1
https://api.churchsuite.com/v1/children/child/1
Data returned by our API follows a number of consistent design patterns. The following are designed to give you an understanding of the current design patterns:
Since we are constantly improving ChurchSuite our API documentation is in flux, we therefore recommend that you watch this project if you plan on using our API. The following modules currently have documented API Endpoints: