Skip to content

Person (Giving)

A Planning Center Person record that has been added to Giving.

A Planning Center Person record that has been added to Giving.

The Person object in Planning Center is so crucial that we have an entire product dedicated to managing, keeping track of, editing, and creating these records and metadata around them. For additional info, take a look at the Planning Center People API Docs.

Property Value
Product Giving (pco.giving, API version 2019-10-18)
Resource type Person
TypeScript Giving.Person, attributes Giving.PersonAttributes, schema Giving.PersonSchema
Planning Center path /giving/v2/people
Planning Center docs Person

How to reach it

Client path Returns Filters Create
pco.giving.people Collection has_donated No
pco.giving.batches.id(batchId).owner Collection No
pco.giving.batch_groups.id(batchGroupId).owner Collection No
pco.giving.donor_summaries.id(donorSummaryId).joint_giver Collection No
pco.giving.in_kind_donations.id(inKindDonationId).person Collection No
pco.giving.people.id(personId).pledges.id(pledgeId).joint_giver Collection No

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

Attributes

On Giving.PersonAttributes. Every resource also has id and type ('Person') next to its attributes.

Name Type Description
addresses unknown[] | null See details.
donor_number number | null The donor number for a person, if applicable. See our product documentation for more information on donor numbers.
email_addresses unknown[] | null See details.
first_donated_at string | null Timestamp of a person’s first donation or null if they have never donated.
first_name string | null A person’s first name.
last_name string | null A person’s last name.
permissions string | null See details.
phone_numbers unknown[] | null See details.

Attribute details

addresses

An array of addresses for a person. Can be managed via People. Example:

  [
    {
      "street_line_1": "2790 Gateway Rd",
      "street_line_2": "",
      "city": "Carlsbad",
      "state": "CA",
      "zip": "92009",
      "location": "Home",
      "primary": true,
      "street": "2790 Gateway Rd",
      "line_1": "2790 Gateway Rd",
      "line_2": "Carlsbad, CA 92009"
    }
  ]

email_addresses

An array of email addresses for a person. Can be managed via People. Example:

  [
    {
      "address": "support@planningcenter.com",
      "location": "Home",
      "blocked": false,
      "primary": true
    }
  ]

permissions

The level of Giving access granted to a person. See our product documentation for more information on permissions in Giving.

Possible values: administrator, reviewer, counter, or bookkeeper

phone_numbers

An array of phone numbers for a person. Can be managed via People. Example:

  [
    {
      "number": "(123) 456-7890",
      "carrier": "PC Mobile",
      "location": "Mobile",
      "primary": true
    }
  ]

Relationships and includes

Planning Center documents no includes for this resource.

Relationship Type To Includable
primary_campus To one Campus No

Querying

Where

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

Field Value type Operators
first_name string Equality only
last_name string Equality only

No documented order fields.

Filters

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

Edge Filters
pco.giving.people has_donated

Edges

Follow these from one Person, ref = pco.giving.people.id(personId):

Edge Leads to Returns Filters Create
ref.batch_groups BatchGroup Collection committed, in_progress No
ref.batches Batch Collection committed, in_progress No
ref.donations Donation Collection No
ref.in_kind_donations InKindDonation Collection No
ref.payment_methods PaymentMethod Collection No
ref.pledges Pledge Collection Yes
ref.primary_campus Campus Collection No
ref.recurring_donations RecurringDonation Collection No

Writing

Property Value
Create No
Update Yes, update() on a reference
Delete No

Update attributes

Typed as Giving.PersonSchema['update'].

Attribute Type
donor_number number | null

See Writing data.

Example

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

const page = await pco.giving.people.perPage(25).list();
const items: Giving.Person[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close