---
title: "Zoom (Services)"
description: "Describes a zoom level for an attachment"
---

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

# Zoom (Services)

Describes a zoom level for an attachment

| Property | Value |
| --- | --- |
| Product | [Services](/reference/services/) (`pco.services`, API version `2018-11-01`) |
| Resource type | `Zoom` |
| TypeScript | `Services.Zoom`, attributes `Services.ZoomAttributes`, schema `Services.ZoomSchema` |
| Planning Center path | `/services/v2/media/{media_id}/attachments/{attachment_id}/zooms` |
| Planning Center docs | [Zoom](https://api.planningcenteronline.com/docs/apps/services/versions/2018-11-01/vertices/zoom) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.services.media.id(mediaId).attachments.id(attachmentId).zooms` | Collection |  | Yes |

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

## Attributes

On `Services.ZoomAttributes`. Every resource also has `id` and `type` (`'Zoom'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `aspect_ratio` | `number \| null` | The aspect ratio of the device this zoom is for. It is rounded to the nearest 3 decimal places. |
| `x_offset` | `number \| null` | The percentage of the document's width the zoomed document should be offset by horizontally. |
| `y_offset` | `number \| null` | The percentage of the document's height the zoomed document should be offset by vertically. |
| `zoom_level` | `number \| null` | The percentage of the zoom. Must be a value between 1.0 and 5.0 |

## Relationships and includes

Planning Center documents no includes for this resource.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `attachable` | To one | [Attachment](/reference/services/attachment/) | No |
| `attachment` | To one | [Attachment](/reference/services/attachment/) | No |
| `person` | To one | [Person](/reference/services/person/) | No |

## Querying

No documented `where` fields.

No documented `order` fields.

## Edges

This resource has no documented edges.

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `zooms` on [Attachment](/reference/services/attachment/) |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

Typed as `Services.ZoomSchema['create']`.

| Attribute | Type |
| --- | --- |
| `aspect_ratio` | `number \| null` |
| `x_offset` | `number \| null` |
| `y_offset` | `number \| null` |
| `zoom_level` | `number \| null` |

### Update attributes

Typed as `Services.ZoomSchema['update']`.

| Attribute | Type |
| --- | --- |
| `x_offset` | `number \| null` |
| `y_offset` | `number \| null` |
| `zoom_level` | `number \| null` |

See [Writing data](/guides/writing-data/).

## Example

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

const mediaId = '1'; // Media id
const attachmentId = '1'; // Attachment id

const page = await pco.services.media.id(mediaId).attachments.id(attachmentId).zooms.perPage(25).list();
const items: Services.Zoom[] = page.data;
```

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