| Property | Value |
|---|---|
| Product | Publishing (pco.publishing, API version 2024-03-25) |
| Resource type | Organization |
| TypeScript | Publishing.Organization, attributes Publishing.OrganizationAttributes, schema Publishing.OrganizationSchema |
| Planning Center path | /publishing/v2 |
| Planning Center docs | Organization |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.publishing.get() |
The product root | No |
Collections support where, include, order, and pagination; single resources have get().
Attributes
On Publishing.OrganizationAttributes. Every resource also has id and type ('Organization') next to its attributes.
| Name | Type | Description |
|---|---|---|
downloads_used |
number | null |
Only available when requested with the ?fields param |
name |
string | null |
|
subdomain |
string | null |
Querying
No documented where fields.
No documented order fields.
Edges
The product root’s edges are the root collections on pco.publishing.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Actions
Run with ref.action(name, body?). Bodies are untyped: see Planning Center’s docs for each action.
| Action | Path | Description |
|---|---|---|
reorder_announcements |
POST /publishing/v2/reorder_announcements |
Reorder Announcements |
Example
import type { Publishing } from '@mackenly/planningcenterkit';
const { data } = await pco.publishing.get(); // GET /publishing/v2
const root: Publishing.Organization = data;