The root level Organization record which serves as a link to Donations, People, Funds, etc.
| Property | Value |
|---|---|
| Product | Giving (pco.giving, API version 2019-10-18) |
| Resource type | Organization |
| TypeScript | Giving.Organization, attributes Giving.OrganizationAttributes, schema Giving.OrganizationSchema |
| Planning Center path | /giving/v2 |
| Planning Center docs | Organization |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.giving.get() |
The product root | No |
Collections support where, include, order, and pagination; single resources have get().
Attributes
On Giving.OrganizationAttributes. Every resource also has id and type ('Organization') next to its attributes.
| Name | Type | Description |
|---|---|---|
name |
string | null |
The name for an organization. |
text2give_enabled |
boolean | null |
true if this organization is accepting Text2Give donations, false otherwise. |
time_zone |
string | null |
The time zone for an organization. |
Querying
No documented where fields.
No documented order fields.
Edges
The product root’s edges are the root collections on pco.giving.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Giving } from '@mackenly/planningcenterkit';
const { data } = await pco.giving.get(); // GET /giving/v2
const root: Giving.Organization = data;