Skip to content

Campus (Groups)

A campus as defined in Planning Center Accounts

A campus as defined in Planning Center Accounts

Property Value
Product Groups (pco.groups, API version 2026-11-10)
Resource type Campus
TypeScript Groups.Campus, attributes Groups.CampusAttributes, schema Groups.CampusSchema
Planning Center path /groups/v2/campuses
Planning Center docs Campus

How to reach it

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

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

Attributes

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

Name Type Description
name string | null The name of the campus

Querying

Where

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

Field Value type Operators
id string Equality only
name string Equality only

Order

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

Edges

Follow these from one Campus, ref = pco.groups.campuses.id(campusId):

Edge Leads to Returns Filters Create
ref.groups Group Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

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

Type to search…

↑↓ navigate↵ selectEsc close