Skip to content

MessageGroup (People)

A message group represents one or more emails or text messages sent from one of the Planning Center apps.

A message group represents one or more emails or text messages sent from one of the Planning Center apps. The message group indicates the from person, app, etc.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type MessageGroup
TypeScript People.MessageGroup, attributes People.MessageGroupAttributes, schema People.MessageGroupSchema
Planning Center path /people/v2/message_groups
Planning Center docs MessageGroup

How to reach it

Client path Returns Filters Create
pco.people.message_groups Collection No
pco.people.messages.id(messageId).message_group Collection No
pco.people.people.id(personId).message_groups Collection No

From a collection, .id(messageGroupId) addresses one MessageGroup: pco.people.message_groups.id(messageGroupId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On People.MessageGroupAttributes. Every resource also has id and type ('MessageGroup') next to its attributes.

Name Type Description
contains_user_generated_content boolean | null
created_at string | null
from_address string | null
message_count number | null
message_type string | null
reply_to_address string | null
reply_to_name string | null
subject string | null
system_message boolean | null
transactional_message boolean | null
uuid string | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): app, from, messages.

Querying

Where

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

Field Value type Operators
contains_user_generated_content boolean Equality only
created_at string | Date gt, gte, lt, lte
from_address string Equality only
message_count number Equality only
message_type string Equality only
reply_to_address string Equality only
reply_to_name string Equality only
subject string Equality only
system_message boolean Equality only
transactional_message boolean Equality only
uuid string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: contains_user_generated_content, created_at, from_address, message_count, message_type, reply_to_address, reply_to_name, subject, system_message, transactional_message, uuid.

Edges

Follow these from one MessageGroup, ref = pco.people.message_groups.id(messageGroupId):

Edge Leads to Returns Filters Create
ref.app App Collection No
ref.from Person Collection No
ref.messages Message Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const page = await pco.people.message_groups.order('contains_user_generated_content').perPage(25).list();
const items: People.MessageGroup[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close