An organization which has people and events. This contains its date format & time zone preferences.
| Property | Value |
|---|---|
| Product | Check-Ins (pco.checkIns, API version 2025-05-28) |
| Resource type | Organization |
| TypeScript | CheckIns.Organization, attributes CheckIns.OrganizationAttributes, schema CheckIns.OrganizationSchema |
| Planning Center path | /check-ins/v2 |
| Planning Center docs | Organization |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.checkIns.get() |
The product root | No | |
pco.checkIns.people.id(personId).organization |
Collection | No |
From a collection, .id(organizationId) addresses one Organization: pco.checkIns.people.id(personId).organization.id(organizationId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On CheckIns.OrganizationAttributes. Every resource also has id and type ('Organization') next to its attributes.
| Name | Type | Description |
|---|---|---|
avatar_url |
string | null |
|
created_at |
string | null |
|
daily_check_ins |
number | null |
|
date_format_pattern |
string | null |
|
name |
string | null |
|
time_zone |
string | null |
|
updated_at |
string | null |
Querying
No documented where fields.
No documented order fields.
Edges
The product root’s edges are the root collections on pco.checkIns.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { CheckIns } from '@mackenly/planningcenterkit';
const { data } = await pco.checkIns.get(); // GET /check-ins/v2
const root: CheckIns.Organization = data;