Skip to main content

Developer API Guide

  • Updated

Introduction

The ChMeetings API allows you to connect your ChMeetings data with custom or external apps that then make that data available for you to use for the specific needs of your church.  

This feature is only available for paid accounts. 

Current features

  • Pull people-related data from ChMeetings, including profile details.
  • Pull groups data from ChMeetings
  • Pull and push contributions data from/to ChMeetings.
  • Pull pledges and campaigns from ChMeetings.
  • Integrate with reporting and dashboard apps,

Note: The API requires a developer with extensive programming knowledge. 

API Documentation

The API Documentation is available here. If you or your developer have any questions or concerns about how to program using our API, please get in touch with our support team. 

Enabling the API

To enable the API:

  • Go to Settings > Integrations > API Integration.
  • Click on Get API.

1._Enable_API.png

  • Your API Key will now be generated. Access to the API Key means access to your data, so please keep this key private and only share it with the people who require it - such as the developer who may be managing this integration for you.

2._API_Key.png

Changing the API Key

Changing your API Key will disable all apps that are using your current key to connect to ChMeetings. Your developer will need to update these apps with the new key to enable them again. 

If you suspect unauthorized access to your data or want to change the API Key due to any security concerns, we recommend that you do so. However, please make sure that the new key is added to your integrated apps, so that they continue working. 



Related articles