Household member scheduling preference
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | SchedulingPreference |
| TypeScript | Services.SchedulingPreference, attributes Services.SchedulingPreferenceAttributes, schema Services.SchedulingPreferenceSchema |
| Planning Center path | /services/v2/people/{person_id}/scheduling_preferences |
| Planning Center docs | SchedulingPreference |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.people.id(personId).scheduling_preferences |
Collection | No |
From a collection, .id(schedulingPreferenceId) addresses one SchedulingPreference: pco.services.people.id(personId).scheduling_preferences.id(schedulingPreferenceId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.SchedulingPreferenceAttributes. Every resource also has id and type ('SchedulingPreference') next to its attributes.
| Name | Type | Description |
|---|---|---|
preference |
string | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
household_member |
To one | Person | 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 page = await pco.services.people.id(personId).scheduling_preferences.perPage(25).list();
const items: Services.SchedulingPreference[] = page.data;