An Attendee is a person registered for a signup.
| Property | Value |
|---|---|
| Product | Registrations (pco.registrations, API version 2025-05-01) |
| Resource type | Attendee |
| TypeScript | Registrations.Attendee, attributes Registrations.AttendeeAttributes, schema Registrations.AttendeeSchema |
| Planning Center path | /registrations/v2/attendees |
| Planning Center docs | Attendee |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.registrations.attendees |
Collection | No | |
pco.registrations.signups.id(signupId).attendees |
Collection | active, canceled, waitlist |
No |
From a collection, .id(attendeeId) addresses one Attendee: pco.registrations.attendees.id(attendeeId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Registrations.AttendeeAttributes. Every resource also has id and type ('Attendee') next to its attributes.
| Name | Type | Description |
|---|---|---|
active |
boolean | null |
Whether or not the attendee is active. |
canceled |
boolean | null |
Whether or not the attendee is canceled. |
complete |
boolean | null |
See details. |
created_at |
string | null |
|
name |
string | null |
See details. |
updated_at |
string | null |
|
waitlisted |
boolean | null |
Whether or not the attendee is waitlisted. |
waitlisted_at |
string | null |
UTC time at which the attendee was waitlisted. |
Attribute details
complete
Whether or not attendee has completed all necessary items (personal information, questions, forms, add ons).
Only available when requested with the ?fields param
name
The attendee’s name. Derived from the associated person record.
Only available when requested with the ?fields param
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): emergency_contact, person, registration, selection_type.
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
attendees on Signup |
active, canceled, waitlist |
Edges
Follow these from one Attendee, ref = pco.registrations.attendees.id(attendeeId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.emergency_contact |
EmergencyContact | Collection | No | |
ref.person |
Person | Collection | No | |
ref.registration |
Registration | Collection | No | |
ref.selection_type |
SelectionType | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Registrations } from '@mackenly/planningcenterkit';
const page = await pco.registrations.attendees.order('created_at').perPage(25).list();
const items: Registrations.Attendee[] = page.data;