---
title: "Attachment (Calendar)"
description: "A file or external link attached to an event."
---

> 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.

# Attachment (Calendar)

A file or external link attached to an event.

| Property | Value |
| --- | --- |
| Product | [Calendar](/reference/calendar/) (`pco.calendar`, API version `2026-06-22`) |
| Resource type | `Attachment` |
| TypeScript | `Calendar.Attachment`, attributes `Calendar.AttachmentAttributes`, schema `Calendar.AttachmentSchema` |
| Planning Center path | `/calendar/v2/attachments` |
| Planning Center docs | [Attachment](https://api.planningcenteronline.com/docs/apps/calendar/versions/2026-06-22/vertices/attachment) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.calendar.attachments` | Collection |  | No |
| `pco.calendar.events.id(eventId).attachments` | Collection |  | No |

From a collection, `.id(attachmentId)` addresses one Attachment: `pco.calendar.attachments.id(attachmentId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `Calendar.AttachmentAttributes`. Every resource also has `id` and `type` (`'Attachment'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `content_type` | `string \| null` | MIME type of the attachment. Null for external links. |
| `created_at` | `string \| null` | UTC time at which the attachment was created |
| `description` | `string \| null` | Description of the attachment |
| `file_size` | `number \| null` | File size in bytes. Null for external links. |
| `kind` | `string \| null` | See [details](#kind). |
| `name` | `string \| null` | Set to the file name if not provided |
| `updated_at` | `string \| null` | UTC time at which the attachment was updated |
| `url` | `string \| null` | Path to where the attachment is stored, or the external link URL for external_link attachments |

### Attribute details

#### `kind` {#kind}

Possible values: file_upload, external_link

Possible values: `file_upload` or `external_link`

## Relationships and includes

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

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `event` | To one | [Event](/reference/calendar/event/) | Yes |

## Querying

### Where

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

| Field | Value type | Operators |
| --- | --- | --- |
| `content_type` | `string` | Equality only |
| `created_at` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |
| `description` | `string` | Equality only |
| `file_size` | `number` | Equality only |
| `kind` | `string` | Equality only |
| `name` | `string` | Equality only |
| `updated_at` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |

### Order

`order(...)` accepts these fields, ascending, or descending with a `-` prefix: `content_type`, `created_at`, `description`, `file_size`, `kind`, `name`, `updated_at`.

## Edges

Follow these from one Attachment, `ref = pco.calendar.attachments.id(attachmentId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.event` | [Event](/reference/calendar/event/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | No |
| Update | No |
| Delete | No |

## Example

```ts
import type { Calendar } from '@mackenly/planningcenterkit';

const page = await pco.calendar.attachments.order('content_type').perPage(25).list();
const items: Calendar.Attachment[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/calendar/attachment/index.mdx
