| Property | Value |
|---|---|
| Product | Publishing (pco.publishing, API version 2024-03-25) |
| Resource type | Speaker |
| TypeScript | Publishing.Speaker, attributes Publishing.SpeakerAttributes, schema Publishing.SpeakerSchema |
| Planning Center path | /publishing/v2/speakers |
| Planning Center docs | Speaker |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.publishing.speakers |
Collection | No | |
pco.publishing.episodes.id(episodeId).speakerships.id(speakershipId).speaker |
Collection | No |
From a collection, .id(speakerId) addresses one Speaker: pco.publishing.speakers.id(speakerId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Publishing.SpeakerAttributes. Every resource also has id and type ('Speaker') next to its attributes.
| Name | Type | Description |
|---|---|---|
avatar_url |
string | null |
|
episodes_count |
number | null |
|
first_name |
string | null |
|
formatted_name |
string | null |
|
last_name |
string | null |
|
name_prefix |
string | null |
|
name_suffix |
string | null |
|
speaker_type |
string | null |
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: first_name.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Publishing } from '@mackenly/planningcenterkit';
const page = await pco.publishing.speakers.order('first_name').perPage(25).list();
const items: Publishing.Speaker[] = page.data;