A Signup is an organization signup that people can register for.
| Property | Value |
|---|---|
| Product | Registrations (pco.registrations, API version 2025-05-01) |
| Resource type | Signup |
| TypeScript | Registrations.Signup, attributes Registrations.SignupAttributes, schema Registrations.SignupSchema |
| Planning Center path | /registrations/v2/signups |
| Planning Center docs | Signup |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.registrations.signups |
Collection | archived, unarchived |
No |
From a collection, .id(signupId) addresses one Signup: pco.registrations.signups.id(signupId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Registrations.SignupAttributes. Every resource also has id and type ('Signup') next to its attributes.
| Name | Type | Description |
|---|---|---|
archived |
boolean | null |
Whether the signup is archived or not. |
at_maximum_capacity |
boolean | null |
See details. |
close_at |
string | null |
UTC time at which regsitration closes. |
closed |
boolean | null |
Whether the signup is currently closed to new registrations. A signup is closed when it is archived, has no open_at, has an open_at in the future, or has a close_at in the past. |
created_at |
string | null |
|
description |
string | null |
Decription of the signup. |
logo_url |
string | null |
URL for the image used for the signup. |
maximum_capacity |
number | null |
Maximum number of attendees this signup can hold across all selection types. null when there is no signup-level capacity limit. |
name |
string | null |
Name of the signup. |
new_registration_url |
string | null |
URL to allow people to register for signup. |
open |
boolean | null |
Whether the signup is currently open to new registrations. Inverse of closed. |
open_at |
string | null |
UTC time at which regsitration opens. |
updated_at |
string | null |
Attribute details
at_maximum_capacity
Whether the signup has reached its signup-level maximum capacity.
Only available when requested with the ?fields param
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): campuses, categories, next_signup_time, selection_types, signup_location, signup_times.
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
id |
string |
Equality only |
name |
string |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at, updated_at.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
pco.registrations.signups |
archived, unarchived |
Edges
Follow these from one Signup, ref = pco.registrations.signups.id(signupId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.attendees |
Attendee | Collection | active, canceled, waitlist |
No |
ref.campuses |
Campus | Collection | No | |
ref.categories |
Category | Collection | No | |
ref.next_signup_time |
SignupTime | Collection | No | |
ref.registrations |
Registration | Collection | No | |
ref.selection_types |
SelectionType | Collection | publicly_available |
No |
ref.signup_location |
SignupLocation | Collection | No | |
ref.signup_times |
SignupTime | Collection | future, past |
No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Registrations } from '@mackenly/planningcenterkit';
const page = await pco.registrations.signups.order('created_at').perPage(25).list();
const items: Registrations.Signup[] = page.data;