Signups that are available.
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | AvailableSignup |
| TypeScript | Services.AvailableSignup, attributes Services.AvailableSignupAttributes, schema Services.AvailableSignupSchema |
| Planning Center path | /services/v2/people/{person_id}/available_signups |
| Planning Center docs | AvailableSignup |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.people.id(personId).available_signups |
Collection | current_organization |
No |
From a collection, .id(availableSignupId) addresses one AvailableSignup: pco.services.people.id(personId).available_signups.id(availableSignupId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.AvailableSignupAttributes. Every resource also has id and type ('AvailableSignup') next to its attributes.
| Name | Type | Description |
|---|---|---|
organization_name |
string | null |
|
planning_center_url |
string | null |
|
service_type_name |
string | null |
|
signups_available |
boolean | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): signup_sheets.
| Relationship | Type | To | Includable |
|---|---|---|---|
organization |
To one | Organization | No |
person |
To one | Person | No |
service_type |
To one | ServiceType | No |
Querying
No documented where fields.
No documented order fields.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
available_signups on Person |
current_organization |
Edges
Follow these from one AvailableSignup, ref = pco.services.people.id(personId).available_signups.id(availableSignupId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.signup_sheets |
SignupSheet | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Services } from '@mackenly/planningcenterkit';
const personId = '1'; // Person id
const page = await pco.services.people.id(personId).available_signups.perPage(25).list();
const items: Services.AvailableSignup[] = page.data;