Skip to content

Publishing reference

Planning Center Publishing in Planning Center Kit: Channels, episodes, series, speakers, and announcements.

Channels, episodes, series, speakers, and announcements.

Property Value
Client property pco.publishing
Subpath import import { createPublishingClient } from '@mackenly/planningcenterkit/publishing'
Types namespace Publishing
Base path /publishing/v2
Pinned API version 2024-03-25
Resource types 18
Planning Center docs Planning Center Publishing API

Each product client sends X-PCO-API-Version: 2024-03-25, the version these types were generated from. Override it with new PlanningCenter({ auth, versions: { publishing: '...' } }); the types won’t follow. See Products.

import { createPublishingClient } from '@mackenly/planningcenterkit/publishing';

const publishing = createPublishingClient({ auth: { applicationId: process.env.PCO_APP_ID!, secret: process.env.PCO_SECRET! } });
const { data: root } = await publishing.get(); // /publishing/v2

Root collections

Properties on pco.publishing, named after their URL. pco.publishing.get() fetches the product root (/publishing/v2), and pco.publishing.edge(name) follows any root edge by name.

Client path Resource Returns Filters Create
pco.publishing.announcement_categories AnnouncementCategory Collection No
pco.publishing.announcement_settings AnnouncementSettings Single resource No
pco.publishing.announcements Announcement Collection active, active_and_scheduled, archived, inactive No
pco.publishing.channels Channel Collection archived, not_archived, podcast_enabled, published Yes
pco.publishing.episodes Episode Collection connected_to_services, not_connected_to_services, not_published_live, published_live, published_on_church_center Yes
pco.publishing.series Series Collection not_published, published, published_on_church_center Yes
pco.publishing.speakers Speaker Collection No

Resources

Resource TypeScript Description
Announcement Publishing.Announcement
AnnouncementCategory Publishing.AnnouncementCategory
AnnouncementSettings Publishing.AnnouncementSettings Settings for how an Organization’s Announcements are displayed
AnnouncementsAnnouncementCategory Publishing.AnnouncementsAnnouncementCategory
AnnouncementsCampus Publishing.AnnouncementsCampus
Channel Publishing.Channel A collection of sermons
ChannelDefaultEpisodeResource Publishing.ChannelDefaultEpisodeResource The default EpisodeResources for a Channel
ChannelDefaultTime Publishing.ChannelDefaultTime The default times for a channel
ChannelNextTime Publishing.ChannelNextTime The next default time for a channel
Episode Publishing.Episode
EpisodeResource Publishing.EpisodeResource
EpisodeStatistics Publishing.EpisodeStatistics Viewership statistics for an episode
EpisodeTime Publishing.EpisodeTime Live schedule times for an Episode
NoteTemplate Publishing.NoteTemplate
Organization Publishing.Organization
Series Publishing.Series
Speaker Publishing.Speaker
Speakership Publishing.Speakership

Type to search…

↑↓ navigate↵ selectEsc close