Skip to content

EpisodeTime (Publishing)

Live schedule times for an Episode

Live schedule times for an Episode

Property Value
Product Publishing (pco.publishing, API version 2024-03-25)
Resource type EpisodeTime
TypeScript Publishing.EpisodeTime, attributes Publishing.EpisodeTimeAttributes, schema Publishing.EpisodeTimeSchema
Planning Center path /publishing/v2/episodes/{episode_id}/episode_times
Planning Center docs EpisodeTime

How to reach it

Client path Returns Filters Create
pco.publishing.episodes.id(episodeId).episode_times Collection Yes

From a collection, .id(episodeTimeId) addresses one EpisodeTime: pco.publishing.episodes.id(episodeId).episode_times.id(episodeTimeId). Collections support where, include, order, and pagination; single resources have get().

Attributes

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

Name Type Description
caveats unknown[] | null
current_state string | null Possible values: upcoming, active, over
current_timestamp number | null
ends_at string | null
starts_at string | null
streaming_service string | null Possible values: vimeo, youtube, livestream_com, resi, facebook, boxcast
video_embed_code string | null
video_url string | null

Querying

No documented where fields.

Order

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

Edges

This resource has no documented edges.

Writing

Property Value
Create Yes, create() on episode_times on Episode
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Publishing.EpisodeTimeSchema['create'].

Attribute Type
_destroy unknown
starts_at string | null
video_embed_code string | null
video_url string | null

Update attributes

Typed as Publishing.EpisodeTimeSchema['update'].

Attribute Type
_destroy unknown
starts_at string | null
video_embed_code string | null
video_url string | null

See Writing data.

Example

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

const episodeId = '1'; // Episode id

const page = await pco.publishing.episodes.id(episodeId).episode_times.order('starts_at').perPage(25).list();
const items: Publishing.EpisodeTime[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close