Details on how and when members can join a Group.
| Property | Value |
|---|---|
| Product | Groups (pco.groups, API version 2026-11-10) |
| Resource type | Enrollment |
| TypeScript | Groups.Enrollment, attributes Groups.EnrollmentAttributes, schema Groups.EnrollmentSchema |
| Planning Center path | /groups/v2/groups/{group_id}/enrollment |
| Planning Center docs | Enrollment |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.groups.groups.id(groupId).enrollment |
Single resource | No |
Collections support where, include, order, and pagination; single resources have get().
Attributes
On Groups.EnrollmentAttributes. Every resource also has id and type ('Enrollment') next to its attributes.
| Name | Type | Description |
|---|---|---|
auto_closed |
boolean | null |
Whether or not enrollment has been closed automatically due to set limits |
auto_closed_reason |
string | null |
Brief description as to which limit automatically closed enrollment |
closed_message |
string | null |
Custom message displayed on Church Center when enrollment is closed. When blank, a default message is shown. |
date_limit |
string | null |
Date when enrollment should automatically close |
date_limit_reached |
boolean | null |
Whether or not the date_limit has been reached |
member_limit |
number | null |
Total number of members allowed before enrollment should automatically close |
member_limit_alert |
number | null |
Number of members that, once exceeded, sends an alert to administrators. |
member_limit_include_pending |
boolean | null |
Whether or not pending membership requests count toward the member_limit. |
member_limit_reached |
boolean | null |
Whether or not the member_limit has been reached |
status |
string | null |
See details. |
strategy |
string | null |
Sign up strategy. Possible values: request_to_join, open_signup, or closed |
Attribute details
status
Current enrollment status. Possible values:
open- strategy is notclosedand no limits have been reachedclosed- strategy isclosedor limits have been reachedfull- member limit has been reachedprivate- group is unlisted
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
group |
To one | Group | No |
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Groups } from '@mackenly/planningcenterkit';
function describe(resource: Groups.Enrollment): string {
return `${resource.type} ${resource.id}`;
}