Skip to main content

Developer API Guide

  • Updated

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.

_______

Organizations & Groups

1. Base URL

 https://api.chmeetings.com 

All endpoints are under:     /api/v1/ 
 

2. Understanding Organizations Hierarchy

The system supports hierarchical organizations:

Diocese

  • Churches

  • Ministries

Church

  • Ministries

If you are on a Diocese Subscription, you can access:

  • Diocese

    • All Churches under the Diocese

    • All Ministries under those Churches

If you are on a Church Subscription, you can access:

  • Church

    • All ministries under the Church.
       

3. Get Organizations

List Organizations:   GET /api/v1/organizations 

  • Returns all organizations accessible by the API key.

  • Behavior depends on subscription:

  • Diocese subscription → Diocese + Churches + Ministries

  • Church subscription → Church + Ministries
     

Supports:

  • Search_text

  • Page

  • Page_size
     

Get Organization By Id:      GET /api/v1/organizations/{organization_id} 

{organization_id} = Id of Diocese, Church, or Ministry.
 

4. Groups API

List Groups per Organization:    GET /api/v1/organizations/{organization_id}/groups 

Use this to retrieve all groups inside:

  • Diocese

  • Church

  • Ministry

Supports:

  • Search_text

  • Page

  • Page_size
     

Get People in Specific Group: 

GET /api/v1/organizations/{organization_id}/groups/{group_id}/memberships 

Parameters:

  • {organization_id} → Diocese/Church/Ministry Id

  • {group_id} → Group Id

  • Page

  • page_size

 

Add Person to Group:

 POST /api/v1/organizations/{organization_id}/groups/{group_id}/memberships 

Request Body:   { "person_id": 1 } 

 

Behavior:

  • Returns 201 if newly added

  • Returns 200 if already exists
     

Remove Person from Group

DELETE/api/v1/organizations/{organization_id}/groups/{group_id}/memberships/{person_id} 

Parameters:

  • {organization_id}

  • {group_id}

  • {person_id}
     

5. Get People in Organization  GET /api/v1/organizations/{organization_id}/people 

Parameters:

  • include_family_members (true/false)

  • include_additional_fields (true/false)

name

mobile

email

page

Page_size

________

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.
     

Batches

  • GET - Get all contribution batches
  • POST - Create a new batch
  • GET - Get a batch by Id
  • PUT - Update a contribution batch
  • DEL - Delete a batch
  • POST - Close a contribution batch
  • POST - Reopen a contribution batch

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. 



 

Related articles