Contents
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 starting with the Growth Plan and requires a developer with extensive programming knowledge..
Features
API Rate Limit: 100 requests per 20s.
_______
People
GET - Pull people data.
POST - Add People,
PUT - Update People records,
DEL - Delete People.
Note that if you are using Native Names, these are included as part of the People API.
Notes
This is an API for data related to profile notes.
GET - Pull notes data, including by member ID
POST - Add notes to profiles,
PUT - Update profile notes,
DEL - Delete profile notes.
Families
- GET family roles.
- GET and POST families.
- GET and DELETE family IDs.
- POST and PUT family members.
DELETE and PATCH family member IDs.
Groups
GET - Pull groups.
Contributions
GET - Pull contributions.
POST - Push contributions.
Pledges
GET - Pull pledges and campaigns.
API Documentation
Browse our dedicated API Documentation, and 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.
Enable the API
To enable the API:
Go to Settings > Integrations > API Integration.
Click on Get API.
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.
Change 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.