Skip to content

PlanTime (Services)

A time in a plan.

A time in a plan.

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type PlanTime
TypeScript Services.PlanTime, attributes Services.PlanTimeAttributes, schema Services.PlanTimeSchema
Planning Center path /services/v2/service_types/{service_type_id}/plan_times
Planning Center docs PlanTime

How to reach it

Client path Returns Filters Create
pco.services.series.id(seriesId).plans.id(planId).needed_positions.id(neededPositionId).time Collection No
pco.services.series.id(seriesId).plans.id(planId).plan_times Collection Yes
pco.services.people.id(personId).plan_people.id(planPersonId).declined_plan_times Collection No
pco.services.people.id(personId).plan_people.id(planPersonId).plan_times Collection No
pco.services.people.id(personId).schedules.id(scheduleId).declined_plan_times Collection No
pco.services.people.id(personId).schedules.id(scheduleId).plan_times Collection No
pco.services.service_types.id(serviceTypeId).plan_times Collection future, named, not_deleted, past No

From a collection, .id(planTimeId) addresses one PlanTime: pco.services.service_types.id(serviceTypeId).plan_times.id(planTimeId). Collections support where, include, order, and pagination; single resources have get().

Attributes

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

Name Type Description
created_at string | null
ends_at string | null Planned end time.
live_ends_at string | null End time as recorded by Services LIVE.
live_starts_at string | null Start time as recorded by Services LIVE.
name string | null
recorded boolean | null
scheduled_team_ids unknown[] | null Only available when requested with the ?fields param
special_service_time boolean | null See details.
starts_at string | null Planned start time.
team_reminders unknown[] | null A Hash that maps a Team ID to a reminder value. If nothing is specified, no reminder is set for that team. A reminder value is an integer (0-7) equal to the number of days before the selected time a reminder should be sent.
time_type string | null See details.
updated_at string | null

Attribute details

special_service_time

True for a service time that matches none of the service type’s regular service times.

Only available when requested with the ?fields param

time_type

Possible values are:

  • rehearsal

  • service

  • other

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): split_team_rehearsal_assignments.

Relationship Type To Includable
assigned_positions To many TeamPosition No
assigned_teams To many Team No

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
time_type string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: starts_at.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
plan_times on ServiceType future, named, not_deleted, past

Edges

Follow these from one PlanTime, ref = pco.services.service_types.id(serviceTypeId).plan_times.id(planTimeId):

Edge Leads to Returns Filters Create
ref.split_team_rehearsal_assignments SplitTeamRehearsalAssignment Collection Yes

Writing

Property Value
Create Yes, create() on plan_times on Plan
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Services.PlanTimeSchema['create'].

Attribute Type
assigned_positions_ids string[]
assigned_teams_ids string[]
change_in_later_times unknown
create_in_next_plan unknown
ends_at string | null
name string | null
starts_at string | null
team_reminders unknown[] | null
time_type string | null
update_scheduled_people unknown

Update attributes

Typed as Services.PlanTimeSchema['update'].

Attribute Type
assigned_positions_ids string[]
assigned_teams_ids string[]
change_in_later_times unknown
create_in_next_plan unknown
ends_at string | null
name string | null
starts_at string | null
team_reminders unknown[] | null
time_type string | null
update_scheduled_people unknown

See Writing data.

Example

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

const serviceTypeId = '1'; // ServiceType id

const page = await pco.services.service_types.id(serviceTypeId).plan_times.order('starts_at').perPage(25).list();
const items: Services.PlanTime[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close