Skip to content

BlockoutDate (Services)

The actual dates generated by the blockout or its recurrence pattern.

The actual dates generated by the blockout or its recurrence pattern. Generated up to a year in advance

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

How to reach it

Client path Returns Filters Create
pco.services.people.id(personId).blockouts.id(blockoutId).blockout_dates Collection No

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

Attributes

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

Name Type Description
ends_at string | null End time as a ‘wall-clock’ timestamp
ends_at_utc string | null
group_identifier string | null
reason string | null
share boolean | null
starts_at string | null Start time as a ‘wall-clock’ timestamp
starts_at_utc string | null
time_zone string | null

Relationships and includes

Planning Center documents no includes for this resource.

Relationship Type To Includable
blockout To one Blockout No
person To one Person No

Querying

No documented where fields.

No documented order fields.

Edges

This resource has no documented edges.

Writing

Property Value
Create No
Update No
Delete No

Example

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

const personId = '1'; // Person id
const blockoutId = '1'; // Blockout id

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

Type to search…

↑↓ navigate↵ selectEsc close