Skip to content

Channel (Publishing)

A collection of sermons

A collection of sermons

Property Value
Product Publishing (pco.publishing, API version 2024-03-25)
Resource type Channel
TypeScript Publishing.Channel, attributes Publishing.ChannelAttributes, schema Publishing.ChannelSchema
Planning Center path /publishing/v2/channels
Planning Center docs Channel

How to reach it

Client path Returns Filters Create
pco.publishing.channels Collection archived, not_archived, podcast_enabled, published Yes
pco.publishing.episodes.id(episodeId).channel Collection No
pco.publishing.series.id(seriesId).channel Collection No

From a collection, .id(channelId) addresses one Channel: pco.publishing.channels.id(channelId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Publishing.ChannelAttributes. Every resource also has id and type ('Channel') next to its attributes.

Name Type Description
activate_episode_minutes_before number | null The activation time for an episode, expressed in minutes before its start
archived boolean | null
art Record<string, unknown> | null An image file object. When setting, pass an upload UUID from the Uploads API (https://api.planningcenteronline.com/docs/overview/file-uploads) or a signed_identifier from an existing File.
can_enable_chat boolean | null
church_center_url string | null
created_at string | null
default_video_duration number | null
default_video_embed_code string | null
default_video_url string | null
description string | null
enable_audio boolean | null
enable_on_demand_video boolean | null
enable_watch_live boolean | null
general_chat_enabled boolean | null
group_chat_enabled boolean | null
name string | null
podcast_art Record<string, unknown> | null An image file object. When setting, pass an upload UUID from the Uploads API (https://api.planningcenteronline.com/docs/overview/file-uploads) or a signed_identifier from an existing File.
podcast_feed_url string | null
podcast_settings Record<string, unknown> | null
position number | null
published boolean | null
sermon_notes_enabled boolean | null
services_service_type_remote_identifier string | null The id for the associated Services Service Type (https://developer.planning.center/docs/#/apps/services/2018-08-01/vertices/service_type)
updated_at string | null
url string | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): channel_default_episode_resources, channel_default_times, current_episode.

Querying

No documented where fields.

Order

order(...) accepts these fields, ascending, or descending with a - prefix: name, position.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
pco.publishing.channels archived, not_archived, podcast_enabled, published

Edges

Follow these from one Channel, ref = pco.publishing.channels.id(channelId):

Edge Leads to Returns Filters Create
ref.channel_default_episode_resources ChannelDefaultEpisodeResource Collection No
ref.channel_default_times ChannelDefaultTime Collection Yes
ref.current_episode Episode Collection No
ref.episodes Episode Collection connected_to_services, not_connected_to_services, not_published, published, published_to_library No
ref.next_times ChannelNextTime Collection No
ref.series Series Collection No
ref.statistics EpisodeStatistics Collection No

Writing

Property Value
Create Yes, create() on pco.publishing.channels
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Publishing.ChannelSchema['create'].

Attribute Type
activate_episode_minutes_before number | null
archived boolean | null
art Record<string, unknown> | null
default_video_duration number | null
default_video_embed_code string | null
default_video_url string | null
description string | null
enable_audio boolean | null
enable_on_demand_video boolean | null
enable_watch_live boolean | null
general_chat_enabled boolean | null
group_chat_enabled boolean | null
name string | null
podcast_art Record<string, unknown> | null
podcast_settings Record<string, unknown> | null
position number | null
published boolean | null
sermon_notes_enabled boolean | null
url string | null

Update attributes

Typed as Publishing.ChannelSchema['update'].

Attribute Type
activate_episode_minutes_before number | null
archived boolean | null
art Record<string, unknown> | null
default_video_duration number | null
default_video_embed_code string | null
default_video_url string | null
description string | null
enable_audio boolean | null
enable_on_demand_video boolean | null
enable_watch_live boolean | null
general_chat_enabled boolean | null
group_chat_enabled boolean | null
name string | null
podcast_art Record<string, unknown> | null
podcast_settings Record<string, unknown> | null
position number | null
published boolean | null
sermon_notes_enabled boolean | null
url string | null

See Writing data.

Example

import type { Publishing } from '@mackenly/planningcenterkit';

const page = await pco.publishing.channels.order('name').perPage(25).list();
const items: Publishing.Channel[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close