Skip to content

ReportTemplate (Calendar)

A template for generating a report.

A template for generating a report.

Property Value
Product Calendar (pco.calendar, API version 2026-06-22)
Resource type ReportTemplate
TypeScript Calendar.ReportTemplate, attributes Calendar.ReportTemplateAttributes, schema Calendar.ReportTemplateSchema
Planning Center path /calendar/v2/report_templates
Planning Center docs ReportTemplate

How to reach it

Client path Returns Filters Create
pco.calendar.report_templates Collection Yes

From a collection, .id(reportTemplateId) addresses one ReportTemplate: pco.calendar.report_templates.id(reportTemplateId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Calendar.ReportTemplateAttributes. Every resource also has id and type ('ReportTemplate') next to its attributes.

Name Type Description
body string | null The contents of the report template
created_at string | null UTC time at which the report was created
description string | null A summarization of the report
title string | null The title of the report
updated_at string | null UTC time at which the report was updated

Querying

No documented where fields.

No documented order fields.

Edges

This resource has no documented edges.

Writing

Property Value
Create Yes, create() on pco.calendar.report_templates
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Calendar.ReportTemplateSchema['create'].

Attribute Type
body string | null
description string | null
title string | null

Update attributes

Typed as Calendar.ReportTemplateSchema['update'].

Attribute Type
body string | null
description string | null
title string | null

See Writing data.

Example

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

const page = await pco.calendar.report_templates.perPage(25).list();
const items: Calendar.ReportTemplate[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close