Skip to content

Live (Services)

The Live resource in Planning Center Services: how to reach it, its attributes, and what you can query and write.

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type Live
TypeScript Services.Live, attributes Services.LiveAttributes, schema Services.LiveSchema
Planning Center path /services/v2/series/{series_id}/plans/{plan_id}/live
Planning Center docs Live

How to reach it

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

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

Attributes

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

Name Type Description
can_chat boolean | null
can_control boolean | null
can_control_video_feed boolean | null
can_take_control boolean | null
chat_room_channel string | null
dates string | null
live_channel string | null
series_title string | null
title string | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): controller, current_item_time, items, next_item_time, service_type.

Querying

No documented where fields.

No documented order fields.

Edges

Follow these from one Live, ref = pco.services.series.id(seriesId).plans.id(planId).live.id(liveId):

Edge Leads to Returns Filters Create
ref.controller Person Collection No
ref.current_item_time ItemTime Collection No
ref.items Item Collection No
ref.next_item_time ItemTime Collection No
ref.service_type ServiceType Collection No
ref.watchable_plans Plan Collection No

Writing

Property Value
Create Documented, but on no path the client follows
Update Yes, update() on a reference
Delete Yes, delete() on a reference

See Writing data.

Actions

Run with ref.action(name, body?). Bodies are untyped: see Planning Center’s docs for each action.

Action Path Description
go_to_next_item POST /services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/go_to_next_item
go_to_previous_item POST /services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/go_to_previous_item
toggle_control POST /services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/toggle_control

Example

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

const seriesId = '1'; // Series id
const planId = '1'; // Plan id

const page = await pco.services.series.id(seriesId).plans.id(planId).live.perPage(25).list();
const items: Services.Live[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close