Skip to content

Series (Services)

A Series can be specified for each plan to tie plans with similar messages together, even across Service Types.

A Series can be specified for each plan to tie plans with similar messages together, even across Service Types.

Note: A series is not created until artwork is added from the plan. You can use series_title included in Plan attributes to get titles for series without artwork.

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type Series
TypeScript Services.Series, attributes Services.SeriesAttributes, schema Services.SeriesSchema
Planning Center path /services/v2/series
Planning Center docs Series

How to reach it

Client path Returns Filters Create
pco.services.series Collection No
pco.services.series.id(seriesId).plans.id(planId).series Collection No

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

Attributes

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

Name Type Description
artwork_content_type string | null
artwork_file_name string | null
artwork_file_size number | null
artwork_for_dashboard string | null
artwork_for_mobile string | null
artwork_for_plan string | null
artwork_original string | null
created_at string | null
has_artwork boolean | null
title string | null
updated_at string | null

Querying

Where

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

Field Value type Operators
title string Equality only

Order

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

Edges

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

Edge Leads to Returns Filters Create
ref.plans Plan Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const page = await pco.services.series.order('created_at').perPage(25).list();
const items: Services.Series[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close