Person
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.
Example Object
{
"type": "Person",
"id": "1",
"attributes": {
"addresses": [],
"donor_number": 1,
"email_addresses": [],
"first_donated_at": "2000-01-01T12:00:00Z",
"first_name": "string",
"last_name": "string",
"permissions": "string",
"phone_numbers": []
},
"relationships": {
"primary_campus": {
"data": {
"type": "Campus",
"id": "1"
}
}
}
}
Attributes
| Name |
Type |
Description |
addresses |
array |
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"
}
]
```
|
donor_number |
integer |
The donor number for a person, if applicable. See our product documentation for more information on [donor numbers](https://pcogiving.zendesk.com/hc/en-us/articles/360012298634-donor-numbers). |
email_addresses |
array |
An array of email addresses for a person. Can be managed via People. Example:
```
[
{
"address": "support@planningcenter.com",
"location": "Home",
"blocked": false,
"primary": true
}
]
```
|
first_donated_at |
date_time |
Timestamp of a person's first donation or `null` if they have never donated. |
first_name |
string |
A person's first name. |
id |
primary_key |
The unique identifier for a person. |
last_name |
string |
A person's last name. |
permissions |
string |
The level of Giving access granted to a person. See our product documentation for more information on [permissions in Giving](https://pcogiving.zendesk.com/hc/en-us/articles/206541708-Permissions-in-Giving).
Possible values: `administrator`, `reviewer`, `counter`, or `bookkeeper` |
phone_numbers |
array |
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
| Name |
Type |
Association Type |
Note |
| primary_campus |
Campus |
to_one |
|
Query By
| Name |
Parameter |
Type |
Description |
Example |
| first_name |
where[first_name] |
string |
Query on a specific first_name |
?where[first_name]=string |
| last_name |
where[last_name] |
string |
Query on a specific last_name |
?where[last_name]=string |
Pagination
| Name |
Parameter |
Type |
Description |
| per_page |
per_page |
integer |
how many records to return per page (min=1, max=100, default=25) |
| offset |
offset |
integer |
get results from given offset |
Endpoints
Listing
| HTTP Method |
Endpoint |
| GET |
/giving/v2/people |
Reading
| HTTP Method |
Endpoint |
| GET |
/giving/v2/people/{id} |
Updating
| HTTP Method |
Endpoint |
Assignable Attributes |
| PATCH |
/giving/v2/people/{id} |
|
Associations
| HTTP Method |
Endpoint |
Returns |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/giving/v2/people/{person_id}/batch_groups |
BatchGroup
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/people/{person_id}/batches |
Batch
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/people/{person_id}/donations |
Donation
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/people/{person_id}/in_kind_donations |
InKindDonation
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/people/{person_id}/payment_methods |
PaymentMethod
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/people/{person_id}/pledges |
Pledge
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/people/{person_id}/primary_campus |
Campus
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/people/{person_id}/recurring_donations |
RecurringDonation
|
|
|
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/giving/v2/batch_groups/{batch_group_id}/owner |
BatchGroup
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/batches/{batch_id}/owner |
Batch
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/in_kind_donations/{in_kind_donation_id}/person |
InKindDonation
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/people |
Organization
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/people/{person_id}/pledges/{pledge_id}/joint_giver |
Pledge
|
|
|