The default EpisodeResources for a Channel
| Property | Value |
|---|---|
| Product | Publishing (pco.publishing, API version 2024-03-25) |
| Resource type | ChannelDefaultEpisodeResource |
| TypeScript | Publishing.ChannelDefaultEpisodeResource, attributes Publishing.ChannelDefaultEpisodeResourceAttributes, schema Publishing.ChannelDefaultEpisodeResourceSchema |
| Planning Center path | /publishing/v2/channels/{channel_id}/channel_default_episode_resources |
| Planning Center docs | ChannelDefaultEpisodeResource |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.publishing.channels.id(channelId).channel_default_episode_resources |
Collection | No |
From a collection, .id(channelDefaultEpisodeResourceId) addresses one ChannelDefaultEpisodeResource: pco.publishing.channels.id(channelId).channel_default_episode_resources.id(channelDefaultEpisodeResourceId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Publishing.ChannelDefaultEpisodeResourceAttributes. Every resource also has id and type ('ChannelDefaultEpisodeResource') next to its attributes.
| Name | Type | Description |
|---|---|---|
featured |
boolean | null |
|
icon |
string | null |
|
kind |
string | null |
Possible values: giving_fund, people_form, generic_url, services_public_page |
position |
number | null |
|
title |
string | null |
|
type |
string | null |
|
url |
string | null |
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Publishing } from '@mackenly/planningcenterkit';
const channelId = '1'; // Channel id
const page = await pco.publishing.channels.id(channelId).channel_default_episode_resources.perPage(25).list();
const items: Publishing.ChannelDefaultEpisodeResource[] = page.data;