Skip to content

GroupType (Groups)

A group type is a category of groups.

A group type is a category of groups. For example, a church might have group types for “Small Groups” and “Classes”.

Property Value
Product Groups (pco.groups, API version 2026-11-10)
Resource type GroupType
TypeScript Groups.GroupType, attributes Groups.GroupTypeAttributes, schema Groups.GroupTypeSchema
Planning Center path /groups/v2/group_types
Planning Center docs GroupType

How to reach it

Client path Returns Filters Create
pco.groups.group_types Collection church_center_visible, not_church_center_visible No
pco.groups.groups.id(groupId).group_type Collection No

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

Attributes

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

Name Type Description
church_center_closed_and_full_groups_visible boolean | null true if closed and full groups are shown by default on the group type’s Church Center page. Otherwise false.
church_center_map_visible boolean | null true if the map view is visible on the public groups list page. Otherwise false.
church_center_visible boolean | null true if the group type contains any published groups. Otherwise false.
color string | null Hex color value. Color themes are a visual tool for administrators on the admin side of Groups. Ex: “#4fd2e3”
default_group_settings string | null A JSON object of default settings for groups of this type.
description string | null A description of the group type
leaders_can_enable_chat boolean | null true if group leaders can enable or disable Chat for their groups. Otherwise false.
name string | null The name of the group type
position number | null The position of the group type in relation to other group types.
public_church_center_web_url string | null The public URL for the group on Church Center.

Querying

Where

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

Field Value type Operators
id string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: name, position.

Filters

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

Edge Filters
pco.groups.group_types church_center_visible, not_church_center_visible

Edges

Follow these from one GroupType, ref = pco.groups.group_types.id(groupTypeId):

Edge Leads to Returns Filters Create
ref.events Event Collection canceled, not_canceled, upcoming No
ref.groups Group Collection No
ref.resources Resource Collection leaders No

Writing

Property Value
Create No
Update No
Delete No

Example

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

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

Type to search…

↑↓ navigate↵ selectEsc close