Skip to content

Blockout (Services)

An object representing a blockout date, and an optional recurrence pattern

An object representing a blockout date, and an optional recurrence pattern

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type Blockout
TypeScript Services.Blockout, attributes Services.BlockoutAttributes, schema Services.BlockoutSchema
Planning Center path /services/v2/people/{person_id}/blockouts
Planning Center docs Blockout

How to reach it

Client path Returns Filters Create
pco.services.people.id(personId).blockouts Collection future, past Yes

From a collection, .id(blockoutId) addresses one Blockout: pco.services.people.id(personId).blockouts.id(blockoutId). Collections support where, include, order, and pagination; single resources have get().

Attributes

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

Name Type Description
created_at string | null
description string | null
ends_at string | null
group_identifier string | null
organization_name string | null
reason string | null
repeat_frequency string | null See details.
repeat_interval string | null See details.
repeat_period string | null See details.
repeat_until string | null
settings string | null
share boolean | null
starts_at string | null
time_zone string | null
updated_at string | null

Attribute details

repeat_frequency

Possible values:

  • no_repeat

  • every_1

  • every_2

  • every_3

  • every_4

  • every_5

  • every_6

  • every_7

  • every_8

repeat_interval

Possible values:

  • exact_day_of_month

  • week_of_month_1

  • week_of_month_2

  • week_of_month_3

  • week_of_month_4

  • week_of_month_last

repeat_period

Possible values:

  • daily

  • weekly

  • monthly

  • yearly

Relationships and includes

Planning Center documents no includes for this resource.

Relationship Type To Includable
organization To one Organization No
person To one Person No

Querying

Where

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

Field Value type Operators
group_identifier string Equality only

No documented order fields.

Filters

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

Edge Filters
blockouts on Person future, past

Edges

Follow these from one Blockout, ref = pco.services.people.id(personId).blockouts.id(blockoutId):

Edge Leads to Returns Filters Create
ref.blockout_dates BlockoutDate Collection No
ref.blockout_exceptions BlockoutException Collection Yes

Writing

Property Value
Create Yes, create() on blockouts on Person
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Services.BlockoutSchema['create'].

Attribute Type
decline_conflicts unknown
ends_at string | null
reason string | null
repeat_frequency string | null
repeat_interval string | null
repeat_period string | null
repeat_until string | null
share boolean | null
starts_at string | null

Update attributes

Typed as Services.BlockoutSchema['update'].

Attribute Type
decline_conflicts unknown
ends_at string | null
reason string | null
repeat_frequency string | null
repeat_interval string | null
repeat_period string | null
repeat_until string | null
share boolean | null
starts_at string | null

See Writing data.

Example

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

const personId = '1'; // Person id

const page = await pco.services.people.id(personId).blockouts.perPage(25).list();
const items: Services.Blockout[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close