The status of syncing a List with Mailchimp.
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | MailchimpSyncStatus |
| TypeScript | People.MailchimpSyncStatus, attributes People.MailchimpSyncStatusAttributes, schema People.MailchimpSyncStatusSchema |
| Planning Center path | /people/v2/lists/{list_id}/mailchimp_sync_status |
| Planning Center docs | MailchimpSyncStatus |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.lists.id(listId).mailchimp_sync_status |
Collection | No |
From a collection, .id(mailchimpSyncStatusId) addresses one MailchimpSyncStatus: pco.people.lists.id(listId).mailchimp_sync_status.id(mailchimpSyncStatusId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.MailchimpSyncStatusAttributes. Every resource also has id and type ('MailchimpSyncStatus') next to its attributes.
| Name | Type | Description |
|---|---|---|
completed_at |
string | null |
|
error |
string | null |
|
progress |
number | null |
|
segment_id |
number | null |
|
status |
string | null |
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 { People } from '@mackenly/planningcenterkit';
const listId = '1'; // List id
const page = await pco.people.lists.id(listId).mailchimp_sync_status.perPage(25).list();
const items: People.MailchimpSyncStatus[] = page.data;