Internal APIs

API Reference

ChurchCRM provides a REST API built on Slim 4. Full interactive documentation is available at:

docs.churchcrm.io → API Reference

Two specs

Spec	Endpoints	Auth
Public API	Login, registration, public calendar, country/state lookups	None
Private API	People, families, groups, finance, events, system admin, kiosk, plugins	x-api-key header

Getting an API key

1. Log in to ChurchCRM
2. Go to your Profile → API Key
3. Copy or generate a new key
4. Pass it as the x-api-key request header

You can also obtain a key programmatically via POST /api/public/user/login.

OpenAPI specs

The raw YAML specs (for importing into tools like Insomnia, Bruno, or Postman) are published alongside the source:

• Public: https://raw.githubusercontent.com/ChurchCRM/CRM/master/openapi/public-api.yaml
• Private: https://raw.githubusercontent.com/ChurchCRM/CRM/master/openapi/private-api.yaml

Note: The Postman collections previously stored in postman/ have been removed. The OpenAPI specs above replace them and are always up-to-date.