Service types, plans, items, songs and arrangements, teams, and schedules.
| Property | Value |
|---|---|
| Client property | pco.services |
| Subpath import | import { createServicesClient } from '@mackenly/planningcenterkit/services' |
| Types namespace | Services |
| Base path | /services/v2 |
| Pinned API version | 2018-11-01 |
| Resource types | 65 |
| Planning Center docs | Planning Center Services API |
Each product client sends X-PCO-API-Version: 2018-11-01, the version these types were generated from. Override it with new PlanningCenter({ auth, versions: { services: '...' } }); the types won’t follow. See Products.
import { createServicesClient } from '@mackenly/planningcenterkit/services';
const services = createServicesClient({ auth: { applicationId: process.env.PCO_APP_ID!, secret: process.env.PCO_SECRET! } });
const { data: root } = await services.get(); // /services/v2Root collections
Properties on pco.services, named after their URL. pco.services.get() fetches the product root (/services/v2), and pco.services.edge(name) follows any root edge by name.
| Client path | Resource | Returns | Filters | Create |
|---|---|---|---|---|
pco.services.attachment_types |
AttachmentType | Collection | No | |
pco.services.chat |
Chat | Collection | No | |
pco.services.email_templates |
EmailTemplate | Collection | Yes | |
pco.services.folders |
Folder | Collection | Yes | |
pco.services.media |
Media | Collection | archived, audio, background_audio, background_image, background_video, countdown, curriculum, document, drama, image, not_archived, powerpoint, song_video, video |
Yes |
pco.services.people |
Person | Collection | No | |
pco.services.plans |
Organization | Collection | No | |
pco.services.report_templates |
ReportTemplate | Collection | matrix, people, plans, without_defaults |
No |
pco.services.series |
Series | Collection | No | |
pco.services.service_types |
ServiceType | Collection | no_parent |
Yes |
pco.services.songs |
Song | Collection | Yes | |
pco.services.tag_groups |
TagGroup | Collection | arrangement, media, person, song |
No |
pco.services.teams |
Team | Collection | editable, service_types |
Yes |
Resources
| Resource | TypeScript | Description |
|---|---|---|
| Arrangement | Services.Arrangement |
Each arrangement belongs to a song and is a different version of that song. |
| ArrangementSections | Services.ArrangementSections |
Sections of an Arrangement, derived from its chord chart |
| Attachment | Services.Attachment |
A file, whether it’s stored on Planning Center or linked from another location. |
| AttachmentActivity | Services.AttachmentActivity |
Returned from the open attachment action. |
| AttachmentType | Services.AttachmentType |
Create an Attachment Type for each type of file you might want only specific people to see. |
| AttachmentTypeGroup | Services.AttachmentTypeGroup |
|
| Attendance | Services.Attendance |
|
| AvailableSignup | Services.AvailableSignup |
Signups that are available. |
| Blockout | Services.Blockout |
An object representing a blockout date, and an optional recurrence pattern |
| BlockoutDate | Services.BlockoutDate |
The actual dates generated by the blockout or its recurrence pattern. |
| BlockoutException | Services.BlockoutException |
A single exception for the dates generated from the blockout |
| BlockoutScheduleConflict | Services.BlockoutScheduleConflict |
|
| Chat | Services.Chat |
|
| Contributor | Services.Contributor |
A Contributor Resource |
| CustomSlide | Services.CustomSlide |
A CustomSlide is used for adding text intended for display on a screen. |
Services.Email |
A persons email | |
| EmailTemplate | Services.EmailTemplate |
A EmailTemplate Resource |
| EmailTemplateRenderedResponse | Services.EmailTemplateRenderedResponse |
A EmailTemplateRenderedResponse Resource |
| Folder | Services.Folder |
A folder is a container used to organize multiple Service Types or other Folders. |
| FolderPath | Services.FolderPath |
The Folder path of a Folder |
| Item | Services.Item |
An item in a plan. |
| ItemAssignment | Services.ItemAssignment |
An assignment of a person or position to a plan item. |
| ItemNote | Services.ItemNote |
A plan item note that belongs to a category. |
| ItemNoteCategory | Services.ItemNoteCategory |
A category of plan item notes for an entire Service Type. |
| ItemTime | Services.ItemTime |
|
| Key | Services.Key |
Each song arrangement can have multiple keys. |
| Live | Services.Live |
|
| LiveController | Services.LiveController |
A person who can control Services LIVE without the required permissions |
| Media | Services.Media |
A piece of media |
| MediaSchedule | Services.MediaSchedule |
|
| NeededPosition | Services.NeededPosition |
An amount of unfilled positions needed within a team in a plan. |
| Organization | Services.Organization |
The root level of an organization where account-level settings are applied. |
| Person | Services.Person |
A person added to Planning Center Services. |
| PersonTeamPositionAssignment | Services.PersonTeamPositionAssignment |
A person’s assignment to a position within a team. |
| Plan | Services.Plan |
A single plan within a Service Type. |
| PlanImportMetadata | Services.PlanImportMetadata |
Metadata about a Plan or Template import |
| PlanNote | Services.PlanNote |
A specific plan note within a single plan. |
| PlanNoteCategory | Services.PlanNoteCategory |
A category of plan notes for an entire Service Type. |
| PlanPerson | Services.PlanPerson |
A person scheduled within a specific plan. |
| PlanPersonTime | Services.PlanPersonTime |
|
| PlanTemplate | Services.PlanTemplate |
A PlanTemplate Resource |
| PlanTime | Services.PlanTime |
A time in a plan. |
| PublicView | Services.PublicView |
Manage options for a public plan |
| ReportTemplate | Services.ReportTemplate |
A template for generating reports |
| Schedule | Services.Schedule |
An instance of a PlanPerson with included data for displaying in a user’s schedule |
| ScheduledPerson | Services.ScheduledPerson |
A person already scheduled to a SignupSheet |
| SchedulingPreference | Services.SchedulingPreference |
Household member scheduling preference |
| Series | Services.Series |
A Series can be specified for each plan to tie plans with similar messages together, even across Service Types. |
| ServiceType | Services.ServiceType |
A Service Type is a container for plans. |
| ServiceTypePath | Services.ServiceTypePath |
The Folder path of a Service Type |
| SignupSheet | Services.SignupSheet |
Available positions to sign up for |
| SignupSheetMetadata | Services.SignupSheetMetadata |
A SignupSheetMetadata Resource |
| SkippedAttachment | Services.SkippedAttachment |
a skipped attachment |
| Song | Services.Song |
A song |
| SongSchedule | Services.SongSchedule |
A upcoming schedule for a song |
| SongbookStatus | Services.SongbookStatus |
Used to get the status of an in progress songbook action. |
| SplitTeamRehearsalAssignment | Services.SplitTeamRehearsalAssignment |
For Rehearsal/Other Times, maps a Split Team to selected Time Preference Options. |
| Tag | Services.Tag |
A tag belonging to a tag group. |
| TagGroup | Services.TagGroup |
A tag group contains tags |
| Team | Services.Team |
A Team within a Service Type. |
| TeamLeader | Services.TeamLeader |
A leader of a specific Team in a Service Type. |
| TeamPosition | Services.TeamPosition |
A position within a team. |
| TextSetting | Services.TextSetting |
|
| TimePreferenceOption | Services.TimePreferenceOption |
A Service Time a person prefers to be scheduled to. |
| Zoom | Services.Zoom |
Describes a zoom level for an attachment |