Skip to content

Attendance (Groups)

Individual event attendance for a person.

Individual event attendance for a person.

Property Value
Product Groups (pco.groups, API version 2026-11-10)
Resource type Attendance
TypeScript Groups.Attendance, attributes Groups.AttendanceAttributes, schema Groups.AttendanceSchema
Planning Center path /groups/v2/events/{event_id}/attendances
Planning Center docs Attendance

How to reach it

Client path Returns Filters Create
pco.groups.events.id(eventId).attendances Collection attended No

From a collection, .id(attendanceId) addresses one Attendance: pco.groups.events.id(eventId).attendances.id(attendanceId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Groups.AttendanceAttributes. Every resource also has id and type ('Attendance') next to its attributes.

Name Type Description
attended boolean | null Whether or not the person attended the event.
role string | null See details.

Attribute details

role

The role of the person at the time of event.

Possible values: member, leader, visitor, or applicant

Relationships and includes

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

Relationship Type To Includable
event To one Event No
person To one Person Yes

Querying

Where

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

Field Value type Operators
role string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: first_name, last_name, role.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
attendances on Event attended

Edges

Follow these from one Attendance, ref = pco.groups.events.id(eventId).attendances.id(attendanceId):

Edge Leads to Returns Filters Create
ref.person Person Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const eventId = '1'; // Event id

const page = await pco.groups.events.id(eventId).attendances.order('first_name').perPage(25).list();
const items: Groups.Attendance[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close