DonorSummary Collection Only

A donor and their aggregate giving to an Organization (name, donor number, total received, donation count, and first gift date), summed over a requested date range, defaulting to the last 30 days.

Example Request

curl https://api.planningcenteronline.com/giving/v2/donor_summaries

View in API Explorer →

Example Object

{
  "type": "DonorSummary",
  "id": "1",
  "attributes": {
    "donation_count": 1,
    "donor_number": "string",
    "first_donated": "2000-01-01T12:00:00Z",
    "name": "string",
    "total_received_donation_amount_cents": 1,
    "total_received_donation_amount_currency": "USD"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`donation_count`	`integer`	The number of donations this donor made over the requested date range, including refunded and failed donations.
`donor_number`	`string`	The donor number for the person, if donor numbers are visible for this organization.
`first_donated`	`date_time`	Timestamp of the donor's first donation ever (lifetime, not scoped to the requested date range).
`id`	`primary_key`	The unique identifier for the donor (the person's id).
`name`	`string`	The donor's full name.
`total_received_donation_amount_cents`	`integer`	The total received donation amount (in the currency's smallest unit) for this donor over the requested date range.
`total_received_donation_amount_currency`	`currency_abbreviation`	The ISO currency code for the total (the organization's currency).

Can Include

Parameter	Value	Description	Assignable
include	joint_giver	include associated joint_giver

Order By

Parameter	Value	Type	Description
order	donation_count	string	prefix with a hyphen (-donation_count) to reverse the order
order	first_donated	string	prefix with a hyphen (-first_donated) to reverse the order
order	name	string	prefix with a hyphen (-name) to reverse the order
order	total_received_donation_amount_cents	string	prefix with a hyphen (-totalreceiveddonationamountcents) to reverse the order

Query By

Name	Parameter	Type	Description	Example
campus_id	`where[campus_id]`	string	Query on a specific campus_id	`?where[campus_id]=string`
person_id	`where[person_id]`	string	Query on a specific person_id	`?where[person_id]=string`
received_at	`where[received_at]`	date_time	Query on a specific received_at	`?where[received_at]=2000-01-01T12:00:00Z`

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/donor_summaries`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/giving/v2/donor_summaries/{donor_summary_id}/joint_giver`	Person

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/giving/v2/donor_summaries`	Organization		`has_joint_giver` filter to donors who are part of a joint giving unit