> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to ChMeetings

The ChMeetings connector lets your AI agent act in each user's ChMeetings account. Each user connects their own ChMeetings API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** API Key
**Categories:** Productivity, CRM & Sales
**Tools:** 60: 33 read, 19 write, 8 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CHMEETINGS)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the ChMeetings connection

   In **AgentKit > Connections**, create a ChMeetings connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'chmeetings'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize ChMeetings:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'chmeetings_accounting_accounts_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "chmeetings"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize ChMeetings:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="chmeetings_accounting_accounts_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their ChMeetings credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'chmeetings_accounting_accounts_list',
  toolInput: {},
  connector: 'chmeetings',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="chmeetings_accounting_accounts_list",
    tool_input={},
    connection_name="chmeetings",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `chmeetings_accounting_accounts_list`

List Accounting Accounts · Read-only

List the ledger accounts (bank registers), optionally with their current balance.
Returns a page of accounts with ID, name, type (asset or liability) and, with include=balance, the running balance.
Use chmeetings_accounting_accounts_list for account balances and IDs. Use chmeetings_accounting_transactions_list for activity.
Needs the API key scope accounting:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include` (`string`, optional): Set to balance to include each account's current running balance. Example: balance
- `include_archived` (`boolean`, optional): Include archived accounts. Default: false. Example: false
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `type` (`string`, optional): Filter by account type. Accepted values: asset, liability. One of: asset, liability. Example: asset. One of: `asset`, `liability`.

Example input: `{}`

### `chmeetings_accounting_categories_list`

List Accounting Categories · Read-only

List the income and expense categories of the ledger.
Returns a page of categories with ID, name, type and parent_category_id (at most two levels).
Use chmeetings_accounting_categories_list to get category IDs for filtering chmeetings_accounting_transactions_list.
Needs the API key scope accounting:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include_archived` (`boolean`, optional): Include archived categories. Default: false. Example: false
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `search` (`string`, optional): Text to filter categories by name (contains match). Example: Utilities
- `type` (`string`, optional): Filter by category type. Accepted values: income, expense. One of: income, expense. Example: expense. One of: `income`, `expense`.

Example input: `{}`

### `chmeetings_accounting_transactions_list`

List Accounting Transactions · Read-only

List general-ledger transactions with their split lines, newest first, filtered by account, date range, type, categories, funds, payee, check number, text or amount.
Returns a page of transactions; amounts are positive and type (income or expense) gives the direction.
Use chmeetings_accounting_transactions_list for the church's books. Use chmeetings_contributions_list for donor giving.
Needs the API key scope accounting:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account_id` (`integer`, optional): Filter to a single account's register. Example: 4
- `category_ids` (`string`, optional): Comma-separated category IDs; matches transactions with at least one line in any of them (e.g. "12" or "12,34"). At most 100 IDs. Example: 12,34
- `check_no` (`string`, optional): Filter by check number (contains match). Example: 1042
- `from` (`string`, optional): Start of the transaction-date range (inclusive). Format: yyyy-MM-dd, church-local. Example: 2026-01-01
- `fund_ids` (`string`, optional): Comma-separated fund IDs; matches transactions with at least one line in any of them (e.g. "3" or "3,7"). At most 100 IDs. Example: 3,7
- `include_beginning_balances` (`boolean`, optional): Include beginning-balance (opening-balance) transactions. Default: true; each row carries is_beginning_balance. Example: true
- `include_voided` (`boolean`, optional): Include voided transactions. Voided rows contribute zero to every balance and are hidden by default. Example: false
- `max_amount` (`number`, optional): Maximum transaction amount (amounts are positive; direction comes from type). Example: 5000
- `min_amount` (`number`, optional): Minimum transaction amount (amounts are positive; direction comes from type). Example: 50
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `payee_id` (`integer`, optional): Filter by payee. Example: 55
- `search` (`string`, optional): Text search across the transaction memo and line notes (contains match). Example: utilities
- `to` (`string`, optional): End of the transaction-date range (inclusive). Format: yyyy-MM-dd, church-local. Example: 2026-01-31
- `type` (`string`, optional): Filter by transaction type. Accepted values: income, expense. One of: income, expense. Example: expense. One of: `income`, `expense`.

Example input: `{}`

### `chmeetings_campaign_pledges_list`

List Campaign Pledges · Read-only

List the pledges made to a campaign.
Returns a page of pledges with the person, pledged amount and amount given so far.
Use chmeetings_campaign_pledges_list to track campaign progress. Use chmeetings_contributions_list for actual gifts.
Needs the API key scope contributions:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `campaign_id` (`integer`, required): Campaign ID, as returned by chmeetings_campaigns_list. Example: 17
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.

Example input: `{"campaign_id":17}`

### `chmeetings_campaigns_list`

List Campaigns · Read-only

List pledge campaigns.
Returns a page of campaigns with ID, name, dates and goal.
Use chmeetings_campaigns_list to find a campaign ID for chmeetings_campaign_pledges_list.
Needs the API key scope contributions:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.

Example input: `{}`

### `chmeetings_contribution_batches_list`

List Contribution Batches · Read-only

List contribution batches.
Returns a page of batches with ID, name, date, status and totals.
Use chmeetings_contribution_batches_list to find a batch ID for chmeetings_contribution_create or chmeetings_contributions_list.
Needs the API key scope contributions:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.

Example input: `{}`

### `chmeetings_contribution_funds_list`

List Contribution Funds · Read-only

List giving funds (such as General Fund or Missions), optionally filtered by name or tax-deductibility.
Returns a page of funds with ID, name, default flag and online-giving flag.
Use chmeetings_contribution_funds_list to get fund IDs for chmeetings_contribution_create. Use chmeetings_accounting_transactions_list for the general ledger.
Needs the API key scope contributions:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `is_tax_deductible` (`boolean`, optional): true returns only tax-deductible funds, false only non-deductible ones. Example: true
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `search_text` (`string`, optional): Text to filter funds by name (contains match). Example: Missions

Example input: `{}`

### `chmeetings_contributions_list`

List Contributions · Read-only

List contributions (donations), filtered by person, date range, batch, reference ID or organization.
Returns a page of contributions with date, giver, amount per fund, payment method and batch.
Use chmeetings_contributions_list for giving history. Use chmeetings_campaign_pledges_list for pledges.
Needs the API key scope contributions:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_id` (`integer`, optional): Returns only the contributions in this batch. Use the batch id from GET /contributions/batches (the same value returned as batch_id on each contribution), not the batch number. Example: 301
- `end_date` (`string`, optional): End of the contribution date range. Format: yyyy-MM-dd. Example: 2026-01-31
- `organization_id` (`string`, optional): Returns only the contributions owned by this organization (the church or one of its ministries). Use an id from GET /organizations. Example: 12345
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `person_id` (`integer`, optional): Only contributions given by this person. Example: 1024567
- `reference_id` (`string`, optional): Only the contribution with this client reference ID. Example: stripe-ch_3Nx
- `start_date` (`string`, optional): Start of the contribution date range. Format: yyyy-MM-dd. Example: 2026-01-01

Example input: `{}`

### `chmeetings_event_get`

Get Event · Read-only

Get one event by ID.
Returns the event's name, description, schedule, location, visibility and image URL.
Use chmeetings_event_get when you know the event ID. Use chmeetings_events_list to browse by date.
Needs the API key scope events:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `event_id` (`integer`, required): Event ID, as returned by chmeetings_events_list. Example: 88123

Example input: `{"event_id":88123}`

### `chmeetings_event_occurrences_list`

List Event Occurrences · Read-only

List the occurrences (individual dates) of an event within a date range of at most 366 days, both materialized and computed.
Returns a page of occurrences with ID, date, time and image URL.
Use chmeetings_event_occurrences_list to get the occurrence ID needed for attendance and check-in tools.
Needs the API key scope events:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `event_id` (`integer`, required): Event ID, as returned by chmeetings_events_list. Example: 88123
- `from` (`string`, required): Start date for filtering occurrences. Format: yyyy-MM-dd. The maximum allowed range between 'from' and 'to' is 366 days. Example: 2026-01-01
- `to` (`string`, required): End date for filtering occurrences. Format: yyyy-MM-dd. The maximum allowed range between 'from' and 'to' is 366 days. Example: 2026-03-31
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.

Example input: `{"event_id":88123,"from":"<from>","to":"<to>"}`

### `chmeetings_event_statistics_get`

Get Event Statistics · Read-only

Get attendance statistics for an event across a date range of at most 366 days.
Returns a per-occurrence attendance summary plus a rollup for the period; include=groups adds a per-group breakdown.
Use chmeetings_event_statistics_get for attendance trends over time. Use chmeetings_occurrence_attendance_summary_get for a single occurrence.
Needs the API key scope events:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `event_id` (`integer`, required): Event ID, as returned by chmeetings_events_list. Example: 88123
- `from` (`string`, required): Range start date (inclusive). Format: yyyy-MM-dd. Maximum range between 'from' and 'to' is 366 days. Example: 2026-01-01
- `to` (`string`, required): Range end date (inclusive). Format: yyyy-MM-dd. Maximum range between 'from' and 'to' is 366 days. Example: 2026-03-31
- `include` (`string`, optional): Set to groups to include a per-group breakdown inside each occurrence. Example: groups

Example input: `{"event_id":88123,"from":"<from>","to":"<to>"}`

### `chmeetings_events_list`

List Events · Read-only

List events within a date range (at most 366 days).
Returns a page of events with ID, name, schedule, visibility and image URL.
Use chmeetings_events_list to find events. Use chmeetings_event_occurrences_list for the individual dates of a recurring event.
Needs the API key scope events:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from` (`string`, required): Start date for filtering events. Format: yyyy-MM-dd. The maximum allowed range between 'from' and 'to' is 366 days. Example: 2026-01-01
- `to` (`string`, required): End date for filtering events. Format: yyyy-MM-dd. The maximum allowed range between 'from' and 'to' is 366 days. Example: 2026-03-31
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.

Example input: `{"from":"<from>","to":"<to>"}`

### `chmeetings_families_list`

List Families · Read-only

List families in the church, optionally filtered by name.
Returns a page of families with their ID and members.
Use chmeetings_families_list to find a family. Use chmeetings_family_get to read one family by ID.
Needs the API key scope people:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `search_text` (`string`, optional): Text to filter families by name (contains match). Example: Smith

Example input: `{}`

### `chmeetings_family_get`

Get Family · Read-only

Get one family by ID.
Returns the family with each member's person ID, name and family role.
Use chmeetings_family_get when you know the family ID. Use chmeetings_families_list to search.
Needs the API key scope people:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `family_id` (`integer`, required): Family ID, as returned by chmeetings_families_list. Example: 9811

Example input: `{"family_id":9811}`

### `chmeetings_family_roles_list`

List Family Roles · Read-only

List the family roles the church uses (for example primary, spouse, child).
Returns each role's name.
Use chmeetings_family_roles_list to pick valid family_role values for chmeetings_family_create and chmeetings_family_members_add.
Needs the API key scope people:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `chmeetings_follow_up_actions_list`

List Follow-Up Actions · Read-only

List the follow-up actions (categories such as First Visit) the church uses, sorted by name.
Returns each action's ID and name.
Use chmeetings_follow_up_actions_list to pick an action_id for chmeetings_follow_up_create.
Needs the API key scope follow_ups:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `chmeetings_follow_up_assignable_members_list`

List Assignable Members · Read-only

List the people who can be assigned follow-ups, sorted by name.
Returns a page of people with their person IDs.
Use chmeetings_follow_up_assignable_members_list to get valid assignee_ids for chmeetings_follow_up_create.
Needs the API key scope follow_ups:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.

Example input: `{}`

### `chmeetings_follow_up_get`

Get Follow-Up · Read-only

Get one follow-up task by ID.
Returns the follow-up's person, assignees, action, date, times, notes, status and completion date.
Use chmeetings_follow_up_get before chmeetings_follow_up_update, which replaces every field.
Needs the API key scope follow_ups:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `follow_up_id` (`integer`, required): Follow-up ID, as returned by chmeetings_follow_ups_list. Example: 33012

Example input: `{"follow_up_id":33012}`

### `chmeetings_follow_ups_list`

List Follow-Ups · Read-only

List pastoral follow-up tasks, filtered by status, type, person, assignee, action, date range or text.
Returns a page of follow-ups with person, assignees, action, date and status.
Use chmeetings_follow_ups_list to review open tasks. Use chmeetings_follow_up_get to read one by ID.
Needs the API key scope follow_ups:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `action_id` (`integer`, optional): Return only follow-ups with this follow-up action (category). Use ids from GET /follow-ups/actions. Example: 12
- `assignee_id` (`integer`, optional): Return only follow-ups assigned to this person (the responsible person). Example: 1024999
- `from` (`string`, optional): Inclusive start of the scheduled-date range (church-local). Format: yyyy-MM-dd. Example: 2026-01-01
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `person_id` (`integer`, optional): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
- `search` (`string`, optional): Free-text search over the person's name, nickname and mobile number. Example: Smith
- `status` (`string`, optional): Filter by status. Omit to return both. One of: pending, done. Example: pending. One of: `pending`, `done`.
- `to` (`string`, optional): Inclusive end of the scheduled-date range (church-local). Format: yyyy-MM-dd. Example: 2026-01-31
- `type` (`string`, optional): Filter by follow-up type. Omit to return all types. One of: visit, phone, sms. Example: visit. One of: `visit`, `phone`, `sms`.

Example input: `{}`

### `chmeetings_group_get`

Get Group · Read-only

Get one group by ID.
Returns the group's name, description, privacy, join option and visibility settings.
Use chmeetings_group_get when you know the group ID. Use chmeetings_groups_list to search by name.
Needs the API key scope groups:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`integer`, required): Group ID, as returned by chmeetings_groups_list. Example: 4521

Example input: `{"group_id":4521}`

### `chmeetings_group_people_list`

List Group People · Read-only

List the people in one or more groups.
Returns the union of the groups' members with their person and group details.
Use chmeetings_group_people_list to see who is in a group. Use chmeetings_people_list with group_ids to filter the full people list instead.
Needs the API key scope groups:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_ids` (`string`, required): Comma-separated group IDs (for example 123 or 123,456,789); the response is the union of those groups' members. Example: 4521,4522

Example input: `{"group_ids":"<group_ids>"}`

### `chmeetings_groups_list`

List Groups · Read-only

List all groups in the church, ordered by name, optionally filtered by name. The list is not paged.
Returns each group's ID, name, description and visibility settings.
Use chmeetings_groups_list to find a group ID. Use chmeetings_group_people_list for the members of groups.
Needs the API key scope groups:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `search_text` (`string`, optional): Text to filter by name (contains match). Example: Youth

Example input: `{}`

### `chmeetings_occurrence_attendance_list`

List Occurrence Attendance · Read-only

List the attendance for one event occurrence, optionally only attendees or absentees, or one group.
Returns a page of people with their check-in and check-out times.
Use chmeetings_occurrence_attendance_list for who attended. Use chmeetings_occurrence_attendance_summary_get for totals only.
Needs the API key scope attendance:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `occurrence_id` (`string`, required): Occurrence ID, as returned by chmeetings_event_occurrences_list. Materialized occurrences have a numeric ID; virtual (not yet materialized) occurrences have a string ID, and both are accepted. Example: 5523411
- `group_id` (`integer`, optional): Only people in this group. Cannot be combined with ungrouped=true. Example: 4521
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `status` (`string`, optional): Which people to return: all, attended or absent. One of: all, attended, absent. Example: attended. One of: `all`, `attended`, `absent`.
- `ungrouped` (`boolean`, optional): If true, returns only ungrouped members. Cannot be combined with group_id. Example: false

Example input: `{"occurrence_id":"<occurrence_id>"}`

### `chmeetings_occurrence_attendance_summary_get`

Get Occurrence Attendance Summary · Read-only

Get attendance totals for one event occurrence.
Returns counts of attended and absent people; include=groups adds a per-group breakdown.
Use chmeetings_occurrence_attendance_summary_get for headcounts. Use chmeetings_occurrence_attendance_list for names.
Needs the API key scope attendance:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `occurrence_id` (`string`, required): Occurrence ID, as returned by chmeetings_event_occurrences_list. Materialized occurrences have a numeric ID; virtual (not yet materialized) occurrences have a string ID, and both are accepted. Example: 5523411
- `include` (`string`, optional): Set to groups to include a per-group attendance breakdown. Example: groups

Example input: `{"occurrence_id":"<occurrence_id>"}`

### `chmeetings_occurrence_get`

Get Occurrence · Read-only

Get one event occurrence by ID, materialized or virtual.
Returns the occurrence's event, date, start and end time.
Use chmeetings_occurrence_get to check an occurrence before recording attendance.
Needs the API key scope events:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `occurrence_id` (`string`, required): Occurrence ID, as returned by chmeetings_event_occurrences_list. Materialized occurrences have a numeric ID; virtual (not yet materialized) occurrences have a string ID, and both are accepted. Example: 5523411

Example input: `{"occurrence_id":"<occurrence_id>"}`

### `chmeetings_organizations_list`

List Organizations · Read-only

List the organizations (church and its ministries) the API key can access.
Returns each organization's ID, name and type.
Use chmeetings_organizations_list to get organization IDs for contribution filters. Use chmeetings_person_organizations_list for one person's organizations.
Needs only a valid API key.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `search_text` (`string`, optional): Text to filter by name (contains match). Example: Smith

Example input: `{}`

### `chmeetings_payment_methods_list`

List Payment Methods · Read-only

List contribution payment methods, both system and custom.
Returns a page of payment methods with ID and name.
Use chmeetings_payment_methods_list to get a payment_method_id for chmeetings_contribution_create.
Needs the API key scope contributions:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `search_text` (`string`, optional): Text to filter payment methods by name (contains match). Example: Check

Example input: `{}`

### `chmeetings_people_fields_list`

List Member Fields · Read-only

List the member profile fields configured for the church, including custom (additional) fields and their options.
Returns each field's ID, name, type and, for dropdown and checkbox fields, the selectable options.
Use chmeetings_people_fields_list before setting additional_fields on chmeetings_person_create or chmeetings_person_update.
Needs the API key scope people:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `chmeetings_people_list`

List People · Read-only

List active people in the church, with filters for name, email, mobile, groups, gender, family role, location and creation date.
Returns a page of people with their profile fields, and optionally their family members, custom fields, organizations and groups.
Use chmeetings_people_list to search or browse members. Use chmeetings_person_get to read one person by ID.
Needs the API key scope people:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `city_id` (`integer`, optional): Filter by the city of the person's address (the 'city' field of the address object). Narrower than state_id - a state contains many cities. Example: 110992
- `country_id` (`integer`, optional): Filter by the country of the person's address. Example: 233
- `created_from` (`string`, optional): Inclusive start of the profile creation-date range (church-local). Format: yyyy-MM-dd. Example: 2026-01-01
- `created_to` (`string`, optional): Inclusive end of the profile creation-date range (church-local). Format: yyyy-MM-dd. Example: 2026-01-31
- `do_not_email` (`boolean`, optional): Filter by the email opt-out flag returned as 'do_not_email'. Example: false
- `do_not_text` (`boolean`, optional): Filter by the SMS opt-out flag returned as 'do_not_text'. Example: false
- `email` (`string`, optional): Filter by email address (contains match). Example: example.com
- `family_roles` (`string`, optional): Comma-separated family roles; matches people in any of them (e.g. "parent" or "parent,child"). Accepted values: primary, spouse, child, parent, sibling, grandparent, other, not_in_family. Omit to match every role. Example: parent,child
- `genders` (`string`, optional): Comma-separated genders; matches people of any of them (e.g. "male" or "male,female"). Accepted values: male, female, unknown. Omit to match every gender. Example: male,female
- `group_ids` (`string`, optional): Comma-separated group IDs; matches people in any of them. Only groups of the current organization are considered. At most 100 IDs. Cannot be combined with ungrouped=true. Example: 4521,4522
- `has_email` (`boolean`, optional): true returns only people with an email address, false only those without. Omit for both. Example: true
- `has_mobile` (`boolean`, optional): true returns only people with a mobile number, false only those without. Omit for both. Example: true
- `has_photo` (`boolean`, optional): true returns only people with a profile photo, false only those without. Omit for both. Example: false
- `include_additional_fields` (`boolean`, optional): Include each person's custom (additional) profile fields. Example: true. Default: `true`.
- `include_family_members` (`boolean`, optional): Include each person's family members in the response. Example: true. Default: `true`.
- `include_groups` (`boolean`, optional): Include each person's groups as a list of id and name. Example: false
- `include_organizations` (`boolean`, optional): Include the organizations (church, ministries) each person belongs to. Example: false. Default: `false`.
- `mobile` (`string`, optional): Filter by mobile number (contains match). Example: 5550123
- `name` (`string`, optional): Filter by name (contains match over the full name and nickname). Example: Smith
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `person_ids` (`string`, optional): Comma-separated person IDs (e.g. "12" or "12,34"). At most 100 IDs. Example: 12,34
- `state_id` (`integer`, optional): Filter by the state of the person's address (the 'state' field of the address object). Example: 1452
- `ungrouped` (`boolean`, optional): If true, returns only people who belong to no group of the current organization. Cannot be combined with group_ids. Example: false
- `zip_code` (`string`, optional): Filter by zip/postal code (contains match). Example: 10001

Example input: `{}`

### `chmeetings_person_get`

Get Person · Read-only

Get one active person in the church by ID.
Returns the person's profile, contact details, address, family and custom fields. Returns 404 Invalid Person Id when the person does not exist or was deleted, archived, removed, merged or converted to a contact.
Use chmeetings_person_get when you know the ID. Use chmeetings_people_list to find someone by name, email or mobile.
Needs the API key scope people:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567

Example input: `{"person_id":1024567}`

### `chmeetings_person_notes_list`

List Person Notes · Read-only

List the public notes recorded on a person's profile.
Returns a page of notes with ID, text, author and date.
Use chmeetings_person_notes_list to read a member's notes. Use chmeetings_person_note_create to add one.
Needs the API key scope people:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.

Example input: `{"person_id":1024567}`

### `chmeetings_person_organizations_list`

List Person Organizations · Read-only

List the organizations (diocese, church, ministries) a person belongs to, main church first.
Returns a page of organizations with ID, name and type.
Use chmeetings_person_organizations_list for one person's memberships. Use chmeetings_organizations_list for every organization the API key can see.
Needs the API key scope people:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.

Example input: `{"person_id":1024567}`

### `chmeetings_posts_list`

List Posts · Read-only

List news posts, optionally filtered by status and publish date range.
Returns a page of posts with ID, title, body, status, visibility, publish date and image URL.
Use chmeetings_posts_list to browse announcements. Use chmeetings_post_create to publish a new one.
Needs the API key scope posts:read.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, optional): End of the date range to filter posts, in the church's timezone. Format: yyyy-MM-dd. Posts that carry no publish date at all (drafts, mainly) are returned whatever the range. Example: 2026-01-31
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1. Default: `1`.
- `page_size` (`integer`, optional): Number of items per page, from 1 to 100. Example: 50. Default: `100`.
- `start_date` (`string`, optional): Start of the date range to filter posts, in the church's timezone. Format: yyyy-MM-dd. Posts that carry no publish date at all (drafts, mainly) are returned whatever the range. Example: 2026-01-01
- `status` (`string`, optional): Return only posts with this status. Omit to return drafts and published posts together. One of: draft, published. Example: published. One of: `draft`, `published`.

Example input: `{}`

### `chmeetings_contribution_batch_close`

Close Contribution Batch · Write

Close a contribution batch so no more contributions can be added.
Returns the updated batch.
Use chmeetings_contribution_batch_close once a batch is reconciled. Use chmeetings_contribution_batch_reopen to allow changes again.
Needs the API key scope contributions:write.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_id` (`integer`, required): Batch ID, as returned by chmeetings_contribution_batches_list. Example: 301

Example input: `{"batch_id":301}`

### `chmeetings_contribution_batch_create`

Create Contribution Batch · Write

Create a contribution batch to group gifts, such as one Sunday's offering.
Returns the created batch with its ID.
Use chmeetings_contribution_batch_create before recording gifts in a batch. Use chmeetings_contribution_batch_close when the batch is complete.
Needs the API key scope contributions:write.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): Batch date, yyyy-MM-dd. Example: 2026-01-11
- `name` (`string`, required): Batch name. Example: Sunday offering 2026-01-11

Example input: `{"date":"<date>","name":"<name>"}`

### `chmeetings_contribution_batch_reopen`

Reopen Contribution Batch · Write

Reopen a closed contribution batch so contributions can be added again.
Returns the updated batch.
Use chmeetings_contribution_batch_reopen to correct a closed batch. Use chmeetings_contribution_batch_close to close it again.
Needs the API key scope contributions:write.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_id` (`integer`, required): Batch ID, as returned by chmeetings_contribution_batches_list. Example: 301

Example input: `{"batch_id":301}`

### `chmeetings_contribution_create`

Create Contribution · Write

Record a contribution (donation) split across one or more funds.
Returns the created contribution. Posting a reference_id that already exists is rejected as a duplicate, so retries are safe.
Use chmeetings_contribution_create to import a gift. Use chmeetings_contribution_batch_create first if you want to group gifts in a batch.
Needs the API key scope contributions:write.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): Contribution date, yyyy-MM-dd. Example: 2026-01-11
- `funds` (`array`, required): How the gift is split: each item needs the fund_name and amount, and may add the fund_id, both from chmeetings_contribution_funds_list. Example: [{"fund_name": "General Fund", "fund_id": 21, "amount": 100.0}]
- `payment_method` (`string`, required): Payment method name, such as Cash, Check or Card. Example: Check
- `batch_id` (`integer`, optional): ID of the batch to put the contribution in, from chmeetings_contribution_batches_list. Example: 301
- `batch_num` (`string`, optional): Batch number to put the contribution in, as an alternative to batch_id. Example: 2026-01-11-A
- `envelope_number` (`integer`, optional): Giver's envelope number. Example: 118
- `note` (`string`, optional): Note on the contribution. Example: Building fund pledge payment
- `payment_method_id` (`integer`, optional): Payment method ID from chmeetings_payment_methods_list. Example: 3
- `payment_provider` (`string`, optional): Name of the payment provider the gift came through, if any. Example: Stripe
- `person` (`object`, optional): The giver: either person_id of an existing person, or first_name, last_name and email or mobile to match or create one. Example: {"person_id": 1024567}
- `reference_id` (`string`, optional): Your unique reference (idempotency key) for this contribution; reusing one is rejected as a duplicate. Example: stripe-ch_3NxA2b

Example input: `{"date":"<date>","funds":[{"fund_name":"General Fund","fund_id":21,"amount":100}],"payment_method":"<payment_method>"}`

### `chmeetings_contribution_fund_create`

Create Contribution Fund · Write

Create a giving fund.
Returns the created fund with its ID.
Use chmeetings_contribution_fund_create to add a new designation for gifts.
Needs the API key scope contributions:write.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Fund name. Example: Building Fund
- `allow_for_online_giving` (`boolean`, optional): Whether donors can choose this fund on the online giving page. Example: true
- `is_default` (`boolean`, optional): Make this the default fund; any existing default is unset. Example: false
- `is_tax_deductible` (`boolean`, optional): Whether gifts to this fund are tax-deductible. Example: true

Example input: `{"name":"<name>"}`

### `chmeetings_family_create`

Create Family · Write

Create a family from existing people; at least two members are required.
Returns the created family with its ID.
Use chmeetings_family_create to link people as a household. Use chmeetings_family_members_add to add people to an existing family.
Needs the API key scope people:write.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `members` (`array`, required): Family members, each with a person_id and a family_role (a role name from chmeetings_family_roles_list, such as primary, spouse or child). Example: [{"person_id": 1024567, "family_role": "primary"}, {"person_id": 1024568, "family_role": "spouse"}]

Example input: `{"members":[{"person_id":1024567,"family_role":"primary"},{"person_id":1024568,"family_role":"spouse"}]}`

### `chmeetings_family_members_add`

Add Family Members · Write

Add people to an existing family.
Returns the updated family.
Use chmeetings_family_members_add to add members. Use chmeetings_family_member_remove to take one out.
Needs the API key scope people:write.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `family_id` (`integer`, required): Family ID, as returned by chmeetings_families_list. Example: 9811
- `members` (`array`, required): Family members, each with a person_id and a family_role (a role name from chmeetings_family_roles_list, such as primary, spouse or child). Example: [{"person_id": 1024567, "family_role": "primary"}, {"person_id": 1024568, "family_role": "spouse"}]

Example input: `{"family_id":9811,"members":[{"person_id":1024567,"family_role":"primary"},{"person_id":1024568,"family_role":"spouse"}]}`

### `chmeetings_follow_up_create`

Create Follow-Up · Write

Create a pastoral follow-up task for a person and assign it to one or more people.
Returns the created follow-up. Assignees with a user account are notified when it is created as pending.
Use chmeetings_follow_up_create to schedule a visit, call or text. Use chmeetings_follow_up_update to change one.
Needs the API key scope follow_ups:write. Get valid assignee IDs from chmeetings_follow_up_assignable_members_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `assignee_ids` (`array`, required): Person IDs of the people responsible for the follow-up, from chmeetings_follow_up_assignable_members_list. At least one is required. Example: [1024999]
- `date` (`string`, required): Scheduled date, church-local yyyy-MM-dd. Example: 2026-02-03
- `person_id` (`integer`, required): ID of the person to follow up with. Example: 1024567
- `action_id` (`integer`, optional): Follow-up action (category) ID from chmeetings_follow_up_actions_list. Example: 12
- `end_time` (`string`, optional): End time on the follow-up date, HH:mm or HH:mm:ss. Required when start_time is set, and not earlier than it. Example: 10:30
- `notes` (`string`, optional): Free-text notes. Example: Welcome call for first-time visitor.
- `start_time` (`string`, optional): Start time on the follow-up date, church-local HH:mm or HH:mm:ss. Defaults to 00:00. Example: 10:00
- `status` (`string`, optional): pending or done. Defaults to pending. One of: pending, done. Example: pending. One of: `pending`, `done`.
- `type` (`string`, optional): How to follow up: visit, phone or sms. Defaults to visit. One of: visit, phone, sms. Example: phone. One of: `visit`, `phone`, `sms`.

Example input: `{"assignee_ids":[1024999],"date":"<date>","person_id":1024567}`

### `chmeetings_follow_up_update`

Update Follow-Up · Write

Replace a follow-up's editable fields; omitted action_id and notes are cleared, an omitted type becomes visit and an omitted status becomes pending.
Returns the updated follow-up.
Use chmeetings_follow_up_update to reschedule, reassign or mark a follow-up done, after reading it with chmeetings_follow_up_get.
Needs the API key scope follow_ups:write.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `assignee_ids` (`array`, required): Person IDs of the people responsible for the follow-up, from chmeetings_follow_up_assignable_members_list. At least one is required. Example: [1024999]
- `follow_up_id` (`integer`, required): Follow-up ID, as returned by chmeetings_follow_ups_list. Example: 33012
- `person_id` (`integer`, required): ID of the person to follow up with. Example: 1024567
- `action_id` (`integer`, optional): Follow-up action (category) ID from chmeetings_follow_up_actions_list. Example: 12
- `date` (`string`, optional): Scheduled date, church-local yyyy-MM-dd. Example: 2026-02-03
- `end_time` (`string`, optional): End time on the follow-up date, HH:mm or HH:mm:ss. Required when start_time is set, and not earlier than it. Example: 10:30
- `notes` (`string`, optional): Free-text notes. Example: Welcome call for first-time visitor.
- `start_time` (`string`, optional): Start time on the follow-up date, church-local HH:mm or HH:mm:ss. Defaults to 00:00. Example: 10:00
- `status` (`string`, optional): pending or done. Defaults to pending. One of: pending, done. Example: pending. One of: `pending`, `done`.
- `type` (`string`, optional): How to follow up: visit, phone or sms. Defaults to visit. One of: visit, phone, sms. Example: phone. One of: `visit`, `phone`, `sms`.

Example input: `{"assignee_ids":[1024999],"follow_up_id":33012,"person_id":1024567}`

### `chmeetings_group_create`

Create Group · Write

Create a group (small group, ministry team, class).
Returns the created group. Returns 400 when the name is already used.
Use chmeetings_group_create to start a new group. Use chmeetings_group_membership_add to add people to it.
Needs the API key scope groups:write.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Group name; must be unique within the organization. Example: Youth Group
- `description` (`string`, optional): Group description; HTML is accepted and stored as given. Example: Teens aged 13 to 18, Fridays at 7pm.

- `is_chat_enabled` (`boolean`, optional): Enable group chat. Requires an active group chat add-on (or a branded mobile app subscription); the request is rejected with 400 otherwise. Example: false
- `is_group_leaders_visible` (`boolean`, optional): Show the group's leaders in the Member Portal. Only takes effect when privacy is "members" or "public", and additionally requires the Online Member Directory to be enabled in the account's Member Role settings. Example: true
- `is_members_visible` (`boolean`, optional): Show the group's members in the Member Portal. Only takes effect when privacy is "members" or "public", and additionally requires the Online Member Directory to be enabled in the account's Member Role settings. Example: false
- `is_visible_to_non_members` (`boolean`, optional): Show this group to members who are not in it. Always forced to true when privacy is "public". Only takes effect when privacy is "members" or "public". Example: true
- `join_request_option` (`string`, optional): Whether members may request to join: "open", "closed", or "approval_required". Defaults to "closed". One of: open, closed, approval_required. Example: approval_required. One of: `open`, `closed`, `approval_required`.
- `privacy` (`string`, optional): Who can see the group: "internal" (visible only to users with access to this feature), "members" (visible in the Member Portal), or "public" (visible to anyone). One of: internal, members, public. Example: members. One of: `internal`, `members`, `public`.

Example input: `{"name":"<name>"}`

### `chmeetings_group_membership_add`

Add Person to Group · Write

Add a person to a group.
Returns the membership; 201 when it was created, 200 when the person was already a member.
Use chmeetings_group_membership_add to enroll someone. Use chmeetings_group_membership_remove to take them out.
Needs the API key scope groups:write.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`integer`, required): Group ID, as returned by chmeetings_groups_list. Example: 4521
- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567

Example input: `{"group_id":4521,"person_id":1024567}`

### `chmeetings_group_update`

Update Group · Write

Replace a group's editable fields; any field left out is reset to its default.
Returns the updated group. Returns 400 when the name is already used by another group.
Use chmeetings_group_update after reading the group with chmeetings_group_get and sending back every field you want to keep.
Needs the API key scope groups:write.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`integer`, required): Group ID, as returned by chmeetings_groups_list. Example: 4521
- `name` (`string`, required): Group name; must be unique within the organization. Example: Youth Group
- `description` (`string`, optional): Group description; HTML is accepted and stored as given. Example: Teens aged 13 to 18, Fridays at 7pm.

- `is_chat_enabled` (`boolean`, optional): Enable group chat. Disabling always succeeds. Enabling requires an active group chat add-on (or a branded mobile app subscription) and a group of at most 1000 active members; the request is rejected with 400 otherwise. Example: false
- `is_group_leaders_visible` (`boolean`, optional): Show the group's leaders in the Member Portal. Only takes effect when privacy is "members" or "public", and additionally requires the Online Member Directory to be enabled in the account's Member Role settings. Example: true
- `is_members_visible` (`boolean`, optional): Show the group's members in the Member Portal. Only takes effect when privacy is "members" or "public", and additionally requires the Online Member Directory to be enabled in the account's Member Role settings. Example: false
- `is_visible_to_non_members` (`boolean`, optional): Show this group to members who are not in it. Always forced to true when privacy is "public". Only takes effect when privacy is "members" or "public". Example: true
- `join_request_option` (`string`, optional): Whether members may request to join: "open", "closed", or "approval_required". Defaults to "closed". One of: open, closed, approval_required. Example: approval_required. One of: `open`, `closed`, `approval_required`.
- `privacy` (`string`, optional): Who can see the group: "internal" (visible only to users with access to this feature), "members" (visible in the Member Portal), or "public" (visible to anyone). One of: internal, members, public. Example: members. One of: `internal`, `members`, `public`.

Example input: `{"group_id":4521,"name":"<name>"}`

### `chmeetings_occurrence_check_in`

Check In to Occurrence · Write

Check a person in to an event occurrence, creating their attendance record.
Returns the attendance record (201), or the existing record (200) when the person is already checked in.
Use chmeetings_occurrence_check_in to record attendance. Use chmeetings_occurrence_check_in_cancel to undo it.
Needs the API key scope attendance:write.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `occurrence_id` (`string`, required): Occurrence ID, as returned by chmeetings_event_occurrences_list. Materialized occurrences have a numeric ID; virtual (not yet materialized) occurrences have a string ID, and both are accepted. Example: 5523411
- `person_id` (`integer`, required): ID of the person to check in, as returned by chmeetings_people_list. Example: 1024567
- `occurred_at` (`string`, optional): When the check-in happened, as the church's local wall-clock time yyyy-MM-ddTHH:mm:ss with no UTC offset (an offset such as Z is rejected). Defaults to now. Example: 2026-08-09T09:14:23

Example input: `{"occurrence_id":"<occurrence_id>","person_id":1024567}`

### `chmeetings_person_create`

Create Person · Write

Create a person (member profile) in the church.
Returns the created person with their new ID.
Use chmeetings_person_create to add a new member. Use chmeetings_person_update to change an existing one.
Needs the API key scope people:write.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `first_name` (`string`, required): First name. Example: John
- `last_name` (`string`, required): Last name. Example: Smith
- `additional_fields` (`array`, optional): Values for the account's custom profile fields, from chmeetings_people_fields_list. Each item gives the field_id, its field_type (text, multi_line_text, number, date, dropdown, checkbox or multiple_choice) and the value: value for text, number and date fields, selected_option_id for dropdown and multiple choice, selected_option_ids for checkbox. Fields left out keep their value. Example: [{"field_id": 12, "field_type": "text", "value": "Choir"}]
- `address` (`object`, optional): Postal address with country, state, city, building, address_line, address_line2, floor, flat and zip_code, all as text. On update, send the whole object: leaving it out clears everything except country, state and city. Example: {"country": "United States", "state": "New York", "city": "New York", "address_line": "12 Main St", "zip_code": "10001"}
- `baptism_date` (`string`, optional): Baptism date as yyyy-MM-dd. Example: 1985-06-01
- `baptism_location` (`string`, optional): Where the person was baptized. Example: St. Mark's Church
- `birth_date` (`string`, optional): Birth date as yyyy-MM-dd. Use the year 1776 when the year is unknown (for example 1776-11-10). Example: 1985-04-12
- `bishop_donor` (`string`, optional): Bishop donor field, for churches that track it. Example: No
- `church` (`string`, optional): Church the person attends, when tracked as a free-text field. Example: St. Mark's
- `do_not_email` (`boolean`, optional): Set true to opt the person out of email. Example: false
- `do_not_text` (`boolean`, optional): Set true to opt the person out of text messages. Example: false
- `education_level` (`string`, optional): Education level. Example: Bachelor's degree
- `email` (`string`, optional): Email address. Example: john.smith@example.com
- `engagement_date` (`string`, optional): Engagement date as yyyy-MM-dd. Example: 2010-05-01
- `facebook` (`string`, optional): Facebook profile URL or handle. Example: https://facebook.com/john.smith
- `father_name` (`string`, optional): Father's name. Example: Robert Smith
- `gender` (`string`, optional): Gender, one of the values returned by GET /api/v1/people/genders (for example Male or Female). Example: Male
- `grade` (`string`, optional): School grade, one of the values returned by GET /api/v1/people/grade-values. Example: 10
- `graduation_year` (`integer`, optional): Graduation year. Example: 2027
- `is_deacon` (`boolean`, optional): Whether the person is a deacon. Example: false
- `job_title` (`string`, optional): Job title. Example: Teacher
- `marriage_date` (`string`, optional): Marriage date as yyyy-MM-dd. Use the year 1776 when the year is unknown. Example: 2011-06-18
- `middle_name` (`string`, optional): Middle name. Example: Paul
- `mobile` (`string`, optional): Mobile phone number, preferably in international format. Example: +15555550123
- `native_name` (`string`, optional): Name in the person's native script, used when Native Name is enabled. Example: Jean Dupont
- `nick_name` (`string`, optional): Nickname, used when the account has Enable Nickname turned on. Example: Johnny
- `qualification` (`string`, optional): Professional qualification. Example: B.Ed.
- `rank` (`string`, optional): Rank, for churches that track clergy rank. Example: Reader
- `school` (`string`, optional): School the person attends or attended. Example: Lincoln High School
- `social_status` (`string`, optional): Marital or social status, one of the values returned by GET /api/v1/people/social-statuses. Example: Married
- `talents_and_hobbies` (`string`, optional): Talents and hobbies, free text. Example: Guitar, cooking
- `telephone` (`string`, optional): Landline telephone number. Example: +15555550100
- `work_place` (`string`, optional): Employer or place of work. Example: Lincoln High School

Example input: `{"first_name":"<first_name>","last_name":"<last_name>"}`

### `chmeetings_person_note_create`

Create Person Note · Write

Add a note to a person's profile.
Returns the created note with its ID.
Use chmeetings_person_note_create to record pastoral or admin notes. Use chmeetings_person_note_update to edit an existing note.
Needs the API key scope people:write.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `note` (`string`, required): Text of the note. Example: Visited after surgery; family asked for prayers.
- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567

Example input: `{"note":"<note>","person_id":1024567}`

### `chmeetings_person_note_update`

Update Person Note · Write

Replace the text of a note on a person's profile.
Returns the updated note.
Use chmeetings_person_note_update to correct a note. Use chmeetings_person_note_create to add a new one.
Needs the API key scope people:write.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `note` (`string`, required): New text of the note; replaces the existing text. Example: Visited after surgery; recovering well.
- `note_id` (`integer`, required): Note ID, as returned by chmeetings_person_notes_list. Example: 7781
- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567

Example input: `{"note":"<note>","note_id":7781,"person_id":1024567}`

### `chmeetings_person_update`

Update Person · Write

Replace a person's profile with the fields you send; this is a full replacement, not a partial update.
Returns the updated person. Fields left out are cleared (including email, mobile and birth date), do_not_email and do_not_text become false, and an omitted address loses everything except country, state and city; nickname, native name and custom fields are kept.
Use chmeetings_person_update after reading the person with chmeetings_person_get, changing the fields and sending the whole profile back.
Needs the API key scope people:write.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `first_name` (`string`, required): First name. Example: John
- `last_name` (`string`, required): Last name. Example: Smith
- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
- `additional_fields` (`array`, optional): Values for the account's custom profile fields, from chmeetings_people_fields_list. Each item gives the field_id, its field_type (text, multi_line_text, number, date, dropdown, checkbox or multiple_choice) and the value: value for text, number and date fields, selected_option_id for dropdown and multiple choice, selected_option_ids for checkbox. Fields left out keep their value. Example: [{"field_id": 12, "field_type": "text", "value": "Choir"}]
- `address` (`object`, optional): Postal address with country, state, city, building, address_line, address_line2, floor, flat and zip_code, all as text. On update, send the whole object: leaving it out clears everything except country, state and city. Example: {"country": "United States", "state": "New York", "city": "New York", "address_line": "12 Main St", "zip_code": "10001"}
- `baptism_date` (`string`, optional): Baptism date as yyyy-MM-dd. Example: 1985-06-01
- `baptism_location` (`string`, optional): Where the person was baptized. Example: St. Mark's Church
- `birth_date` (`string`, optional): Birth date as yyyy-MM-dd. Use the year 1776 when the year is unknown (for example 1776-11-10). Example: 1985-04-12
- `bishop_donor` (`string`, optional): Bishop donor field, for churches that track it. Example: No
- `church` (`string`, optional): Church the person attends, when tracked as a free-text field. Example: St. Mark's
- `do_not_email` (`boolean`, optional): Set true to opt the person out of email. Example: false
- `do_not_text` (`boolean`, optional): Set true to opt the person out of text messages. Example: false
- `education_level` (`string`, optional): Education level. Example: Bachelor's degree
- `email` (`string`, optional): Email address. Example: john.smith@example.com
- `engagement_date` (`string`, optional): Engagement date as yyyy-MM-dd. Example: 2010-05-01
- `facebook` (`string`, optional): Facebook profile URL or handle. Example: https://facebook.com/john.smith
- `father_name` (`string`, optional): Father's name. Example: Robert Smith
- `gender` (`string`, optional): Gender, one of the values returned by GET /api/v1/people/genders (for example Male or Female). Example: Male
- `grade` (`string`, optional): School grade, one of the values returned by GET /api/v1/people/grade-values. Example: 10
- `graduation_year` (`integer`, optional): Graduation year. Example: 2027
- `is_deacon` (`boolean`, optional): Whether the person is a deacon. Example: false
- `job_title` (`string`, optional): Job title. Example: Teacher
- `marriage_date` (`string`, optional): Marriage date as yyyy-MM-dd. Use the year 1776 when the year is unknown. Example: 2011-06-18
- `middle_name` (`string`, optional): Middle name. Example: Paul
- `mobile` (`string`, optional): Mobile phone number, preferably in international format. Example: +15555550123
- `native_name` (`string`, optional): Name in the person's native script, used when Native Name is enabled. Example: Jean Dupont
- `nick_name` (`string`, optional): Nickname, used when the account has Enable Nickname turned on. Example: Johnny
- `qualification` (`string`, optional): Professional qualification. Example: B.Ed.
- `rank` (`string`, optional): Rank, for churches that track clergy rank. Example: Reader
- `school` (`string`, optional): School the person attends or attended. Example: Lincoln High School
- `social_status` (`string`, optional): Marital or social status, one of the values returned by GET /api/v1/people/social-statuses. Example: Married
- `talents_and_hobbies` (`string`, optional): Talents and hobbies, free text. Example: Guitar, cooking
- `telephone` (`string`, optional): Landline telephone number. Example: +15555550100
- `work_place` (`string`, optional): Employer or place of work. Example: Lincoln High School

Example input: `{"first_name":"<first_name>","last_name":"<last_name>","person_id":1024567}`

### `chmeetings_post_create`

Create Post · Write

Create a news post (announcement), as a draft or published, optionally notifying members.
Returns the created post with its ID.
Use chmeetings_post_create to share news with members. Use chmeetings_post_update to edit a post.
Needs the API key scope posts:write.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `body` (`string`, required): Post content as rich-text HTML. Example: Join us at 9am and 11am on Easter Sunday.

- `status` (`string`, required): draft stores the post unpublished; published makes it live. One of: draft, published. Example: published. One of: `draft`, `published`.
- `title` (`string`, required): Post title, at most 500 characters. Example: Easter service times
- `visibility` (`string`, required): Who can see the post: internal (only users with access), members (also members in the Member Portal) or public. One of: internal, members, public. Example: members. One of: `internal`, `members`, `public`.
- `allow_comments` (`boolean`, optional): Whether members can comment on the post. Example: true
- `allow_likes` (`boolean`, optional): Whether members can like the post. Example: true
- `category_ids` (`array`, optional): IDs of post categories to assign; every ID must belong to this organization. Example: [2]
- `notify_members` (`boolean`, optional): Send members a push notification about the post; only takes effect when status is published. Example: false
- `published_on` (`string`, optional): Publish date in the church's timezone, yyyy-MM-dd (a plain date, not a UTC instant). Example: 2026-04-01

Example input: `{"body":"<body>","status":"draft","title":"<title>","visibility":"internal"}`

### `chmeetings_post_update`

Update Post · Write

Update a news post; title, body, status and visibility are required and replace the stored values, and category_ids replaces the categories.
Returns the updated post.
Use chmeetings_post_update to edit or publish a draft. Use chmeetings_post_create for a new post.
Needs the API key scope posts:write.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `body` (`string`, required): Post content as rich-text HTML. Example: Join us at 9am and 11am on Easter Sunday.

- `post_id` (`integer`, required): Post ID, as returned by chmeetings_posts_list. Example: 812
- `status` (`string`, required): draft stores the post unpublished; published makes it live. One of: draft, published. Example: published. One of: `draft`, `published`.
- `title` (`string`, required): Post title, at most 500 characters. Example: Easter service times
- `visibility` (`string`, required): Who can see the post: internal (only users with access), members (also members in the Member Portal) or public. One of: internal, members, public. Example: members. One of: `internal`, `members`, `public`.
- `allow_comments` (`boolean`, optional): Whether members can comment on the post. Example: true
- `allow_likes` (`boolean`, optional): Whether members can like the post. Example: true
- `category_ids` (`array`, optional): IDs of post categories to assign; every ID must belong to this organization. Example: [2]
- `notify_members` (`boolean`, optional): Send members a push notification about the post; only takes effect when status is published. Example: false
- `published_on` (`string`, optional): Publish date in the church's timezone, yyyy-MM-dd (a plain date, not a UTC instant). Example: 2026-04-01

Example input: `{"body":"<body>","post_id":812,"status":"draft","title":"<title>","visibility":"internal"}`

### `chmeetings_contribution_delete`

Delete Contribution · Destructive

Delete a contribution by ID.
Returns a confirmation.
Use chmeetings_contribution_delete to remove a gift recorded by mistake.
Needs the API key scope contributions:delete.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `contribution_id` (`integer`, required): Contribution ID, as returned by chmeetings_contributions_list. Example: 556677

Example input: `{"contribution_id":556677}`

### `chmeetings_family_member_remove`

Remove Family Member · Destructive

Remove a person from a family; the family must keep at least two members.
Returns a confirmation.
Use chmeetings_family_member_remove to take one person out. Use chmeetings_family_members_add to add people.
Needs the API key scope people:write.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `family_id` (`integer`, required): Family ID, as returned by chmeetings_families_list. Example: 9811
- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567

Example input: `{"family_id":9811,"person_id":1024567}`

### `chmeetings_follow_up_delete`

Delete Follow-Up · Destructive

Delete a follow-up task. Deleting the latest occurrence of a recurring follow-up schedules the next one.
Returns a confirmation, or 404 when it does not exist.
Use chmeetings_follow_up_delete to cancel a task. Use chmeetings_follow_up_update with status done to complete it instead.
Needs the API key scope follow_ups:delete.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `follow_up_id` (`integer`, required): Follow-up ID, as returned by chmeetings_follow_ups_list. Example: 33012

Example input: `{"follow_up_id":33012}`

### `chmeetings_group_delete`

Delete Group · Destructive

Delete a group with all its memberships and leader assignments.
Returns a confirmation. Returns 400 while the group is still assigned to upcoming events.
Use chmeetings_group_delete to remove a group permanently. Use chmeetings_group_membership_remove to remove one person instead.
Needs the API key scope groups:delete.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`integer`, required): Group ID, as returned by chmeetings_groups_list. Example: 4521

Example input: `{"group_id":4521}`

### `chmeetings_group_membership_remove`

Remove Person from Group · Destructive

Remove a person from a group.
Returns a confirmation, or 404 when the person is not in the group.
Use chmeetings_group_membership_remove to take one person out. Use chmeetings_group_delete to delete the whole group.
Needs the API key scope groups:write.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`integer`, required): Group ID, as returned by chmeetings_groups_list. Example: 4521
- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567

Example input: `{"group_id":4521,"person_id":1024567}`

### `chmeetings_occurrence_check_in_cancel`

Cancel Check-In · Destructive

Cancel a person's check-in to an event occurrence, removing the attendance record and any check-out.
Returns a confirmation, or 404 when the person has no active check-in.
Use chmeetings_occurrence_check_in_cancel to undo a check-in recorded by mistake.
Needs the API key scope attendance:write.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `occurrence_id` (`string`, required): Occurrence ID, as returned by chmeetings_event_occurrences_list. Materialized occurrences have a numeric ID; virtual (not yet materialized) occurrences have a string ID, and both are accepted. Example: 5523411
- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567

Example input: `{"occurrence_id":"<occurrence_id>","person_id":1024567}`

### `chmeetings_person_delete`

Delete Person · Destructive

Delete a person from the church.
Returns a confirmation. Sends a person.deleted webhook.
Use chmeetings_person_delete only to remove a profile permanently. Use chmeetings_person_update to change details instead.
Needs the API key scope people:delete.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567

Example input: `{"person_id":1024567}`

### `chmeetings_person_note_delete`

Delete Person Note · Destructive

Delete a note from a person's profile.
Returns a confirmation.
Use chmeetings_person_note_delete to remove a note permanently.
Needs the API key scope people:delete.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `note_id` (`integer`, required): Note ID, as returned by chmeetings_person_notes_list. Example: 7781
- `person_id` (`integer`, required): ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567

Example input: `{"note_id":7781,"person_id":1024567}`

## Related

Other Productivity connectors ([all 203](/agentkit/connectors/?category=productivity)):

- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Notion](/agentkit/connectors/notion/): Scalekit connector, OAuth, 51 tools
- [Google Workspace (DWD)](/agentkit/connectors/googledwd/): Scalekit connector, Service account, 100 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
