Skip to content

Group (Groups)

A group of people that meet together regularly.

A group of people that meet together regularly.

Property Value
Product Groups (pco.groups, API version 2026-11-10)
Resource type Group
TypeScript Groups.Group, attributes Groups.GroupAttributes, schema Groups.GroupSchema
Planning Center path /groups/v2/groups
Planning Center docs Group

How to reach it

Client path Returns Filters Create
pco.groups.groups Collection campus, enrollment, group, group_type, meeting_schedule, my_groups, people_database_searchable, tag No
pco.groups.campuses.id(campusId).groups Collection No
pco.groups.events.id(eventId).group Collection No
pco.groups.group_applications.id(groupApplicationId).group Collection No
pco.groups.group_types.id(groupTypeId).groups Collection No
pco.groups.events.id(eventId).location.id(locationId).group Collection No
pco.groups.memberships.id(membershipId).group Collection No
pco.groups.people.id(personId).groups Collection No
pco.groups.groups.id(groupId).tags.id(tagId).groups Collection No

From a collection, .id(groupId) addresses one Group: pco.groups.groups.id(groupId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Groups.GroupAttributes. Every resource also has id and type ('Group') next to its attributes.

Name Type Description
archived_at string | null The date and time the group was archived.
can_create_conversation boolean | null See details.
can_create_conversation_reason_code string | null See details.
chat_enabled boolean | null A boolean representing whether or not the group has Chat enabled.
contact_email string | null If a contact_email is provided, we will display a contact button on the public page where potential members can ask questions before joining the group.
created_at string | null The date and time the group was created.
default_event_automated_reminders_enabled boolean | null Whether or not new events for this group send automated reminders by default.
default_event_rsvp_guests_enabled boolean | null Whether or not new events for this group allow RSVP guest counts by default.
default_event_rsvps_enabled boolean | null Whether or not new events for this group have RSVPs enabled by default.
description string | null A longform description of the group. Can contain HTML markup.
description_as_plain_text string | null The plain text version of the group description.
direct_messages_enabled boolean | null A boolean representing whether or not direct messages are enabled for the group.
events_listed boolean | null Whether or not events are visible to the public on Church Center
events_visibility string | null See details.
header_image Record<string, unknown> | null A hash of header image URLs. The keys are thumbnail, medium, and original.
leader_name_visible_on_public_page boolean | null Whether or not the first names of group leaders are displayed on the group’s public Church Center page.
leaders_can_search_people_database boolean | null Whether or not group leaders have access to the entire church database on the admin side of Groups. (Not recommended)
location_type_preference string | null See details.
members_are_confidential boolean | null Whether or not group members can see other members’ info
members_can_create_conversations boolean | null Whether or not members, not just leaders, can start new conversations in the group’s Chat.
memberships_count number | null The number of members in the group, includes leaders. Does not include membership requests.
name string | null The name/title of the group.
public_church_center_web_url string | null The public URL for the group on Church Center.
publicly_display_meeting_schedule boolean | null Whether or not the group’s meeting schedule is displayed on its public Church Center page.
request_event_attendance_from_leaders boolean | null Whether or not group leaders and attendance takers are emailed shortly before each event starts asking them to take attendance.
schedule string | null A text summary of the group’s typical meeting schedule. Can be a string like “Sundays at 9:30am” or “Every other Tuesday at 7pm”.
tag_ids number | null See details.
virtual_location_url string | null The URL for the group’s virtual location. A zoom link, for example. This could be set even if location_type_preference is physical. This is useful if you want to display a zoom link even if the group is meeting in person.
visibility string | null See details.
widget_status Record<string, unknown> | null See details.

Attribute details

can_create_conversation

A boolean representing the current user’s authorization to start a new conversation in the group.

Only available when requested with the ?fields param

can_create_conversation_reason_code

A code representing why the current user can or cannot start a new conversation in the group. Possible values: chat_disabled, group_archived, non_member, leaders_only. Nil when the user is permitted to create a conversation.

Only available when requested with the ?fields param

events_visibility

The visibility of events for the group.

Possible values: public or members

location_type_preference

The location type preference for the group.

Possible values: physical or virtual

tag_ids

The IDs of the tags associated with the group.

Only available when requested with the ?fields param

visibility

If and how the group is visible on Church Center:

  • “private”: Not visible to anyone, aside from members of the group.
  • “link_only”: Visible by sharing a direct link to the group, as well as by the group’s members.
  • “public”: Visible in the public group directory.

When ordering, values sort as “public”, “link_only”, then “private”.

Possible values: private, link_only, or public

widget_status

DEPRECATED: This is a private attribute used by Home widgets that we plan to remove soon.

Only available when requested with the ?fields param

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): enrollment, group_type, location.

Relationship Type To Includable
attendance_reply_to_person To one Person No
group_type To one GroupType Yes
location To one Location Yes

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
archive_status string Equality only
name string Equality only
visibility string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: chat_enabled, contact_email, created_at, enrollment_limit, members_are_confidential, memberships_count, name, visibility.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
pco.groups.groups campus, enrollment, group, group_type, meeting_schedule, my_groups, people_database_searchable, tag

Edges

Follow these from one Group, ref = pco.groups.groups.id(groupId):

Edge Leads to Returns Filters Create
ref.applications GroupApplication Collection No
ref.campuses Campus Collection No
ref.enrollment Enrollment Single resource No
ref.events Event Collection canceled, not_canceled No
ref.group_type GroupType Collection No
ref.location Location Collection No
ref.memberships Membership Collection Yes
ref.my_membership Membership Collection No
ref.people Person Collection No
ref.resources Resource Collection leaders No
ref.tags Tag Collection No

Writing

Property Value
Create No
Update Yes, update() on a reference
Delete No

Update attributes

Typed as Groups.GroupSchema['update'].

Attribute Type
group_type_id string
name string | null
public_enrollment unknown
publicly_display_meeting_schedule boolean | null
schedule string | null
tag_ids number | null
visibility string | null

See Writing data.

Actions

Run with ref.action(name, body?). Bodies are untyped: see Planning Center’s docs for each action.

Action Path Description
assign_campuses POST /groups/v2/groups/{group_id}/assign_campuses
disable_chat POST /groups/v2/groups/{group_id}/disable_chat
duplicate POST /groups/v2/groups/{group_id}/duplicate
enable_chat POST /groups/v2/groups/{group_id}/enable_chat

Example

import type { Groups } from '@mackenly/planningcenterkit';

const page = await pco.groups.groups.order('chat_enabled').perPage(25).list();
const items: Groups.Group[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close