Signups, registrations, attendees, and categories.
| Property | Value |
|---|---|
| Client property | pco.registrations |
| Subpath import | import { createRegistrationsClient } from '@mackenly/planningcenterkit/registrations' |
| Types namespace | Registrations |
| Base path | /registrations/v2 |
| Pinned API version | 2025-05-01 |
| Resource types | 11 |
| Planning Center docs | Registrations API |
Each product client sends X-PCO-API-Version: 2025-05-01, the version these types were generated from. Override it with new PlanningCenter({ auth, versions: { registrations: '...' } }); the types won’t follow. See Products.
import { createRegistrationsClient } from '@mackenly/planningcenterkit/registrations';
const registrations = createRegistrationsClient({ auth: { applicationId: process.env.PCO_APP_ID!, secret: process.env.PCO_SECRET! } });
const { data: root } = await registrations.get(); // /registrations/v2Root collections
Properties on pco.registrations, named after their URL. pco.registrations.get() fetches the product root (/registrations/v2), and pco.registrations.edge(name) follows any root edge by name.
| Client path | Resource | Returns | Filters | Create |
|---|---|---|---|---|
pco.registrations.attendees |
Attendee | Collection | No | |
pco.registrations.campuses |
Campus | Collection | No | |
pco.registrations.categories |
Category | Collection | No | |
pco.registrations.people |
Person | Collection | No | |
pco.registrations.registrations |
Registration | Collection | No | |
pco.registrations.signups |
Signup | Collection | archived, unarchived |
No |
Resources
| Resource | TypeScript | Description |
|---|---|---|
| Attendee | Registrations.Attendee |
An Attendee is a person registered for a signup. |
| Campus | Registrations.Campus |
A Campus is a location belonging to an Organization. |
| Category | Registrations.Category |
A Category is a label used to group together and find signups more easily. |
| EmergencyContact | Registrations.EmergencyContact |
EmergencyContact is the person assigned as the emergency contact for an attendee. |
| Organization | Registrations.Organization |
The root level Organization record which serves as a link to Signups. |
| Person | Registrations.Person |
|
| Registration | Registrations.Registration |
|
| SelectionType | Registrations.SelectionType |
SelectionTypes are used to present the options people register for in a signup. |
| Signup | Registrations.Signup |
A Signup is an organization signup that people can register for. |
| SignupLocation | Registrations.SignupLocation |
Signuplocation is the location of a signup. |
| SignupTime | Registrations.SignupTime |
Signuptimes are associated with a signup, which can have multiple signup times. |