A upcoming schedule for a song
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | SongSchedule |
| TypeScript | Services.SongSchedule, attributes Services.SongScheduleAttributes, schema Services.SongScheduleSchema |
| Planning Center path | /services/v2/songs/{song_id}/song_schedules |
| Planning Center docs | SongSchedule |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.songs.id(songId).song_schedules |
Collection | after, before, most_recent, most_recent_with_upcoming, three_most_recent |
No |
From a collection, .id(songScheduleId) addresses one SongSchedule: pco.services.songs.id(songId).song_schedules.id(songScheduleId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.SongScheduleAttributes. Every resource also has id and type ('SongSchedule') next to its attributes.
| Name | Type | Description |
|---|---|---|
arrangement_name |
string | null |
|
key_name |
string | null |
|
plan_dates |
string | null |
|
plan_sort_date |
string | null |
|
plan_visible |
boolean | null |
|
service_type_name |
string | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
arrangement |
To one | Arrangement | No |
item |
To one | Item | No |
key |
To one | Key | No |
plan |
To one | Plan | No |
service_type |
To one | ServiceType | No |
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: plan_sort_date.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
song_schedules on Song |
after, before, most_recent, most_recent_with_upcoming, three_most_recent |
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Services } from '@mackenly/planningcenterkit';
const songId = '1'; // Song id
const page = await pco.services.songs.id(songId).song_schedules.order('plan_sort_date').perPage(25).list();
const items: Services.SongSchedule[] = page.data;