| Property | Value |
|---|---|
| Product | Current (pco.current, API version 2018-08-01) |
| Resource type | Organization |
| TypeScript | Current.Organization, attributes Current.OrganizationAttributes, schema Current.OrganizationSchema |
| Planning Center path | /current/v2 |
| Planning Center docs | Organization |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.current.get() |
The product root | No | |
pco.current.people.id(personId).organization |
Collection | No |
From a collection, .id(organizationId) addresses one Organization: pco.current.people.id(personId).organization.id(organizationId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Current.OrganizationAttributes. Every resource also has id and type ('Organization') next to its attributes.
| Name | Type | Description |
|---|---|---|
name |
string | null |
|
subdomain |
string | null |
|
time_zone |
string | null |
Querying
No documented where fields.
No documented order fields.
Edges
The product root’s edges are the root collections on pco.current.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Current } from '@mackenly/planningcenterkit';
const { data } = await pco.current.get(); // GET /current/v2
const root: Current.Organization = data;