| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | Chat |
| TypeScript | Services.Chat, attributes Services.ChatAttributes, schema Services.ChatSchema |
| Planning Center path | /services/v2/chats |
| Planning Center docs | Chat |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.chat |
Collection | No |
From a collection, .id(chatId) addresses one Chat: pco.services.chat.id(chatId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.ChatAttributes. Every resource also has id and type ('Chat') next to its attributes.
| Name | Type | Description |
|---|---|---|
group_identifiers |
unknown[] | null |
Only available when requested with the ?fields param |
my_teams |
unknown[] | null |
Only available when requested with the ?fields param |
payload |
string | null |
Only available when requested with the ?fields param |
people |
unknown[] | null |
Only available when requested with the ?fields param |
plans |
unknown[] | null |
Only available when requested with the ?fields param |
teams |
unknown[] | null |
Only available when requested with the ?fields param |
teams_i_lead |
unknown[] | null |
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 { Services } from '@mackenly/planningcenterkit';
const page = await pco.services.chat.perPage(25).list();
const items: Services.Chat[] = page.data;