Planning Center API Clients

TypeScript client libraries for Planning Center Online APIs.

Packages

This monorepo contains three packages:

People API Client (External Documentation)

Package: @rachelallyson/planning-center-people-ts Version: v2.14.0

Complete TypeScript client for Planning Center People API with 11 specialized modules (people, fields, workflows, contacts, households, notes, lists, campus, serviceTime, forms, reports).

Note: See package-specific documentation at /people for People API guides and reference.

Check-Ins API Client

Package: @rachelallyson/planning-center-check-ins-ts Version: v2.0.0

Complete TypeScript client for Planning Center Check-Ins API with specialized modules for events, locations, check-ins, stations, labels, and more.

Base Package

Package: @rachelallyson/planning-center-base-ts Version: v1.0.2

Shared infrastructure for building PCO API clients - HTTP client, authentication, rate limiting, pagination, error handling, JSON:API types.

Quick Start

Installation


# People API Client
npm install @rachelallyson/planning-center-people-ts
 
# Check-Ins API Client
npm install @rachelallyson/planning-center-check-ins-ts
 
# Base Package (for building custom clients)
npm install @rachelallyson/planning-center-base-ts

Basic Usage


import { PcoClient } from '@rachelallyson/planning-center-people-ts';
 
// Option 1: Environment variables (recommended)
const client = new PcoClient({
  auth: {
    type: 'personal_access_token',
    personalAccessToken: process.env.PCO_PERSONAL_ACCESS_TOKEN!
  }
});
 
// Option 2: Direct configuration (convenient for development)
// const client = new PcoClient({
//   auth: {
//     type: 'personal_access_token',
//     personalAccessToken: 'your_client_id',
//     personalAccessTokenSecret: 'your_client_secret'
//   }
// });
 
// Find or create a person
const person = await client.people.findOrCreate({
  firstName: 'John',
  lastName: 'Doe',
  email: 'john@example.com'
});
 
console.log(`Person ID: ${person.id}`);

See Quick Start Guide for complete Personal Access Token setup instructions.

Documentation

Guides

Quick Start - Get up and running in 5 minutes
Pagination - Handling paginated responses
Error Handling - Typed errors, retries, recovery
Event System - Monitoring and observability

Reference

Configuration - All config options and environment variables
API Reference - Complete API documentation

Concepts

Core Concepts - Architecture, mental models, invariants

Examples

Recipes - Copy-paste code snippets

Troubleshooting

Monorepo Issues - Common setup and build issues

Requirements

Node.js: >= 16.0.0
TypeScript: >= 4.0 (recommended)