Create an Attachment Type for each type of file you might want only specific people to see. When you attach a file, you can specify an attachment type to then be able to link the file to a position.
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | AttachmentType |
| TypeScript | Services.AttachmentType, attributes Services.AttachmentTypeAttributes, schema Services.AttachmentTypeSchema |
| Planning Center path | /services/v2/attachment_types |
| Planning Center docs | AttachmentType |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.attachment_types |
Collection | No |
From a collection, .id(attachmentTypeId) addresses one AttachmentType: pco.services.attachment_types.id(attachmentTypeId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.AttachmentTypeAttributes. Every resource also has id and type ('AttachmentType') next to its attributes.
| Name | Type | Description |
|---|---|---|
aliases |
string | null |
|
built_in |
boolean | null |
|
capoed_chord_charts |
boolean | null |
|
chord_charts |
boolean | null |
|
exclusions |
string | null |
|
lyrics |
boolean | null |
|
name |
string | null |
|
number_charts |
boolean | null |
|
numeral_charts |
boolean | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
attachment_type_group |
To one | AttachmentTypeGroup | No |
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: name.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Services } from '@mackenly/planningcenterkit';
const page = await pco.services.attachment_types.order('name').perPage(25).list();
const items: Services.AttachmentType[] = page.data;