A Campus that has been added to your Organization.
Campuses can be especially useful in filtering Donations across the various locations of your Organization.
| Property | Value |
|---|---|
| Product | Giving (pco.giving, API version 2019-10-18) |
| Resource type | Campus |
| TypeScript | Giving.Campus, attributes Giving.CampusAttributes, schema Giving.CampusSchema |
| Planning Center path | /giving/v2/campuses |
| Planning Center docs | Campus |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.giving.campuses |
Collection | No | |
pco.giving.donations.id(donationId).campus |
Collection | No | |
pco.giving.in_kind_donations.id(inKindDonationId).campus |
Collection | No | |
pco.giving.people.id(personId).primary_campus |
Collection | No |
From a collection, .id(campusId) addresses one Campus: pco.giving.campuses.id(campusId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Giving.CampusAttributes. Every resource also has id and type ('Campus') next to its attributes.
| Name | Type | Description |
|---|---|---|
address |
Record<string, unknown> | null |
The address for a campus. Campus descriptions can be set via Accounts or the People API. |
name |
string | null |
The name for a campus. Campus names can be set via Accounts or the People API. |
Querying
No documented where fields.
No documented order fields.
Edges
Follow these from one Campus, ref = pco.giving.campuses.id(campusId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.donations |
Donation | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Giving } from '@mackenly/planningcenterkit';
const page = await pco.giving.campuses.perPage(25).list();
const items: Giving.Campus[] = page.data;