Skip to content

GroupApplication (Groups)

A group application is a request to join a group which can be approved or rejected.

A group application is a request to join a group which can be approved or rejected.

Property Value
Product Groups (pco.groups, API version 2026-11-10)
Resource type GroupApplication
TypeScript Groups.GroupApplication, attributes Groups.GroupApplicationAttributes, schema Groups.GroupApplicationSchema
Planning Center path /groups/v2/group_applications
Planning Center docs GroupApplication

How to reach it

Client path Returns Filters Create
pco.groups.group_applications Collection No
pco.groups.groups.id(groupId).applications Collection No

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

Attributes

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

Name Type Description
applied_at string | null Timestamp when this person applied.
message string | null An optional personal message from the applicant.
status string | null See details.

Attribute details

status

The approval status of the application.

Possible values: pending, approved, or rejected

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): group, person.

Relationship Type To Includable
group To one Group Yes
person To one Person Yes

Querying

Where

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

Field Value type Operators
applied_at string | Date gt, gte, lt, lte
status string Equality only

Order

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

Edges

Follow these from one GroupApplication, ref = pco.groups.group_applications.id(groupApplicationId):

Edge Leads to Returns Filters Create
ref.group Group Collection No
ref.person Person Collection No

Writing

Property Value
Create No
Update No
Delete No

Actions

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

Action Path Description
approve POST /groups/v2/group_applications/{group_application_id}/approve
reject POST /groups/v2/group_applications/{group_application_id}/reject

Example

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

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

Type to search…

↑↓ navigate↵ selectEsc close