A person already scheduled to a SignupSheet
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | ScheduledPerson |
| TypeScript | Services.ScheduledPerson, attributes Services.ScheduledPersonAttributes, schema Services.ScheduledPersonSchema |
| Planning Center path | /services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets/{signup_sheet_id}/scheduled_people |
| Planning Center docs | ScheduledPerson |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.people.id(personId).available_signups.id(availableSignupId).signup_sheets.id(signupSheetId).scheduled_people |
Collection | No |
From a collection, .id(scheduledPersonId) addresses one ScheduledPerson: pco.services.people.id(personId).available_signups.id(availableSignupId).signup_sheets.id(signupSheetId).scheduled_people.id(scheduledPersonId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.ScheduledPersonAttributes. Every resource also has id and type ('ScheduledPerson') next to its attributes.
| Name | Type | Description |
|---|---|---|
full_name |
string | null |
|
status |
string | null |
|
thumbnail |
string | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
person |
To one | Person | No |
signup_sheet |
To one | SignupSheet | No |
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 { Services } from '@mackenly/planningcenterkit';
const personId = '1'; // Person id
const availableSignupId = '1'; // AvailableSignup id
const signupSheetId = '1'; // SignupSheet id
const page = await pco.services.people.id(personId).available_signups.id(availableSignupId).signup_sheets.id(signupSheetId).scheduled_people.perPage(25).list();
const items: Services.ScheduledPerson[] = page.data;