Signup_location is the location of a signup.
| Property | Value |
|---|---|
| Product | Registrations (pco.registrations, API version 2025-05-01) |
| Resource type | SignupLocation |
| TypeScript | Registrations.SignupLocation, attributes Registrations.SignupLocationAttributes, schema Registrations.SignupLocationSchema |
| Planning Center path | /registrations/v2/signups/{signup_id}/signup_location |
| Planning Center docs | SignupLocation |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.registrations.signups.id(signupId).signup_location |
Collection | No |
From a collection, .id(signupLocationId) addresses one SignupLocation: pco.registrations.signups.id(signupId).signup_location.id(signupLocationId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Registrations.SignupLocationAttributes. Every resource also has id and type ('SignupLocation') next to its attributes.
| Name | Type | Description |
|---|---|---|
address_data |
Record<string, unknown> | null |
See details. |
created_at |
string | null |
|
formatted_address |
string | null |
The formatted address of the signup location, which may not include subpremise details. |
full_formatted_address |
string | null |
The fully formatted address of the signup location, including subpremise details. |
latitude |
string | null |
The latitude of the signup location. |
location_type |
string | null |
The type of location, such as address, coords, or online. |
longitude |
string | null |
The longitude of the signup location. |
name |
string | null |
The name of the signup location. |
subpremise |
string | null |
The subpremise of the signup location, such as an building or room number. |
updated_at |
string | null |
|
url |
string | null |
The URL for the signup location, if applicable (e.g., for online events). |
Attribute details
address_data
The address data of the signup location, which includes details like street, city, state, and postal code.
Only available when requested with the ?fields param
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Registrations } from '@mackenly/planningcenterkit';
const signupId = '1'; // Signup id
const page = await pco.registrations.signups.id(signupId).signup_location.perPage(25).list();
const items: Registrations.SignupLocation[] = page.data;