| Property | Value |
|---|---|
| Product | Publishing (pco.publishing, API version 2024-03-25) |
| Resource type | Speakership |
| TypeScript | Publishing.Speakership, attributes Publishing.SpeakershipAttributes, schema Publishing.SpeakershipSchema |
| Planning Center path | /publishing/v2/episodes/{episode_id}/speakerships |
| Planning Center docs | Speakership |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.publishing.episodes.id(episodeId).speakerships |
Collection | No |
From a collection, .id(speakershipId) addresses one Speakership: pco.publishing.episodes.id(episodeId).speakerships.id(speakershipId). Collections support where, include, order, and pagination; single resources have get().
Attributes
This resource has no documented attributes.
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): speaker.
| Relationship | Type | To | Includable |
|---|---|---|---|
speaker |
To one | Speaker | Yes |
Querying
No documented where fields.
No documented order fields.
Edges
Follow these from one Speakership, ref = pco.publishing.episodes.id(episodeId).speakerships.id(speakershipId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.speaker |
Speaker | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Update attributes
Typed as Publishing.SpeakershipSchema['update'].
| Attribute | Type |
|---|---|
_destroy |
unknown |
See Writing data.
Example
import type { Publishing } from '@mackenly/planningcenterkit';
const episodeId = '1'; // Episode id
const page = await pco.publishing.episodes.id(episodeId).speakerships.perPage(25).list();
const items: Publishing.Speakership[] = page.data;