Admin
Administration operations (Admin role required)
📄️ Reset a user's password to a random value and email it to them (Admin role required)
Reset a user's password to a random value and email it to them (Admin role required)
📄️ Disable two-factor authentication for a user (Admin role required)
Disable two-factor authentication for a user (Admin role required)
📄️ Reset failed login counter and send unlock email (Admin role required)
Reset failed login counter and send unlock email (Admin role required)
📄️ Delete a user account (Admin role required)
Delete a user account (Admin role required)
📄️ Get permission flags for a user (Admin role required)
Get permission flags for a user (Admin role required)
📄️ List orphaned files
Returns files present on disk that are not part of the official ChurchCRM release.
📄️ Delete all orphaned files
Delete all orphaned files
📄️ Get upgrade preview: release notes and path without downloading
Get upgrade preview: release notes and path without downloading
📄️ Download the latest release from GitHub (or a specific version)
Download the latest release from GitHub (or a specific version)
📄️ Apply the system upgrade
Apply the system upgrade
📄️ Refresh upgrade information from GitHub
Forces a fresh check of available updates from GitHub and updates session state.
📄️ Delete every queued composer message so it is never sent
Deletes the email history rows whose status is `queued`, in every batch. Messages being sent at that moment (`sending`) and the history of sent, failed and skipped mail are left alone. A composer still sending one of the deleted batches gets 404 for it. The deletion is written to the app log with the administrator's name.
📄️ Send a test birthday email to the current admin (Admin role required)
Send a test birthday email to the current admin (Admin role required)
📄️ Get the yearly grade promotion settings, last run and preview
The promotion month and day, the next automatic promotion date, the last promotion marker and result, and how many people a promotion would move up or clear from the last grade.
📄️ Move everyone with a grade up one grade now
Counts as this year's promotion. The last grade is cleared, deceased people are skipped and each moved person gets a timeline note. A browser session must send the CSRF token in X-CSRF-Token; API-key calls do not.
📄️ List the grade names available for each country
List the grade names available for each country
📄️ Preview what applying a country's grade names would change
Preview what applying a country's grade names would change
📄️ Rename the grades to a country's names, as previewed
People keep their grade. The plan is checked against expectedState under row locks before anything changes. A browser session must send the CSRF token in X-CSRF-Token; API-key calls do not.
📄️ List all volunteer opportunities (Admin role required)
List all volunteer opportunities (Admin role required)
📄️ Create a new volunteer opportunity (Admin role required)
Create a new volunteer opportunity (Admin role required)
📄️ Get a single volunteer opportunity (Admin role required)
Get a single volunteer opportunity (Admin role required)
📄️ Update a volunteer opportunity (Admin role required)
Update a volunteer opportunity (Admin role required)
📄️ Delete a volunteer opportunity (Admin role required)
Delete a volunteer opportunity (Admin role required)
📄️ Get the current church logo status
Reports whether an administrator has uploaded a church logo and the URL currently resolved for it.
📄️ Upload the church logo (base64 encoded)
Accepts a base64 data URI (JPEG, PNG, GIF or WebP), downscales it to fit 1200x400 and stores it as Images/church-logo.png.
📄️ Remove the uploaded church logo
Deletes Images/church-logo.png. Idempotent — succeeds even when no logo is stored.
📄️ Get the current value of a system setting
Returns the stored value, or the shipped default when none is stored. Password settings always return an empty value.
📄️ Set the value of a system setting
An empty value for a password setting keeps the stored password. A number setting takes a number; it takes an empty value only when its shipped default is empty.
📄️ List all property types
List all property types
📄️ Create a new property type
Create a new property type
📄️ Get a single property type
Get a single property type
📄️ Update a property type
Update a property type
📄️ Delete a property type
Delete a property type
📄️ Delete a property definition and all its assignments
Delete a property definition and all its assignments
📄️ Import demo data into the application (Admin role required)
Only available on fresh installations with exactly 1 person, unless the force flag is set.
📄️ Export all people as a ChMeetings-compatible CSV file (Admin role required)
Export all people as a ChMeetings-compatible CSV file (Admin role required)
📄️ Drop all database tables and views, clear uploaded images, and destroy the session (Admin role required)
This operation is irreversible. After reset the session is destroyed and default credentials (admin/changeme) apply.
Can't find what you need? Ask in Discord, or open an issue on the ChurchCRM repository.