---
title: "Blockout (Services)"
description: "An object representing a blockout date, and an optional recurrence pattern"
---

> Documentation Index
> Fetch the complete documentation index at: https://planningcenterkit.mackenly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Blockout (Services)

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

| Property | Value |
| --- | --- |
| Product | [Services](/reference/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](https://api.planningcenteronline.com/docs/apps/services/versions/2018-11-01/vertices/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](/guides/querying/); 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-frequency). |
| `repeat_interval` | `string \| null` | See [details](#repeat-interval). |
| `repeat_period` | `string \| null` | See [details](#repeat-period). |
| `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` {#repeat-frequency}

Possible values:

- no_repeat

- every_1

- every_2

- every_3

- every_4

- every_5

- every_6

- every_7

- every_8

#### `repeat_interval` {#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` {#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](/reference/services/organization/) | No |
| `person` | To one | [Person](/reference/services/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](/reference/services/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](/reference/services/blockout-date/) | Collection |  | No |
| `ref.blockout_exceptions` | [BlockoutException](/reference/services/blockout-exception/) | Collection |  | Yes |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `blockouts` on [Person](/reference/services/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](/guides/writing-data/).

## Example

```ts
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;
```

Source: https://planningcenterkit.mackenly.com/reference/services/blockout/index.mdx
