| Property | Value |
|---|---|
| Product | Publishing (pco.publishing, API version 2024-03-25) |
| Resource type | AnnouncementsAnnouncementCategory |
| TypeScript | Publishing.AnnouncementsAnnouncementCategory, attributes Publishing.AnnouncementsAnnouncementCategoryAttributes, schema Publishing.AnnouncementsAnnouncementCategorySchema |
| Planning Center path | /publishing/v2/announcements/{announcement_id}/announcements_announcement_categories |
| Planning Center docs | AnnouncementsAnnouncementCategory |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.publishing.announcements.id(announcementId).announcements_announcement_categories |
Collection | No |
From a collection, .id(announcementsAnnouncementCategoryId) addresses one AnnouncementsAnnouncementCategory: pco.publishing.announcements.id(announcementId).announcements_announcement_categories.id(announcementsAnnouncementCategoryId). Collections support where, include, order, and pagination; single resources have get().
Attributes
This resource has no documented attributes.
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): announcement_category.
| Relationship | Type | To | Includable |
|---|---|---|---|
announcement_category |
To one | AnnouncementCategory | Yes |
Querying
No documented where fields.
No documented order fields.
Edges
Follow these from one AnnouncementsAnnouncementCategory, ref = pco.publishing.announcements.id(announcementId).announcements_announcement_categories.id(announcementsAnnouncementCategoryId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.announcement_category |
AnnouncementCategory | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Publishing } from '@mackenly/planningcenterkit';
const announcementId = '1'; // Announcement id
const page = await pco.publishing.announcements.id(announcementId).announcements_announcement_categories.perPage(25).list();
const items: Publishing.AnnouncementsAnnouncementCategory[] = page.data;