Skip to content

Series (Publishing)

The Series resource in Planning Center Publishing: how to reach it, its attributes, and what you can query and write.

Property Value
Product Publishing (pco.publishing, API version 2024-03-25)
Resource type Series
TypeScript Publishing.Series, attributes Publishing.SeriesAttributes, schema Publishing.SeriesSchema
Planning Center path /publishing/v2/series
Planning Center docs Series

How to reach it

Client path Returns Filters Create
pco.publishing.series Collection not_published, published, published_on_church_center Yes
pco.publishing.channels.id(channelId).series Collection No
pco.publishing.episodes.id(episodeId).series Collection No

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

Attributes

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

Name Type Description
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.
church_center_url string | null
created_at string | null
description string | null
ended_at string | null
episodes_count number | null
published boolean | null
started_at string | null
title string | null
updated_at string | null

Relationships and includes

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

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
id string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: ended_at, episodes_count, started_at, title.

Filters

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

Edge Filters
pco.publishing.series not_published, published, published_on_church_center

Edges

Follow these from one Series, ref = pco.publishing.series.id(seriesId):

Edge Leads to Returns Filters Create
ref.channel Channel Collection No

Writing

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

Create attributes

Typed as Publishing.SeriesSchema['create'].

Attribute Type
art Record<string, unknown> | null
description string | null
published boolean | null
title string | null

Update attributes

Typed as Publishing.SeriesSchema['update'].

Attribute Type
art Record<string, unknown> | null
description string | null
published boolean | null
title string | null

See Writing data.

Example

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

const page = await pco.publishing.series.order('ended_at').perPage(25).list();
const items: Publishing.Series[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close