Skip to content

API reference

Planning Center API in Planning Center Kit: OAuth applications, personal access tokens, and connected applications.

OAuth applications, personal access tokens, and connected applications.

Property Value
Client property pco.api
Subpath import import { createApiClient } from '@mackenly/planningcenterkit/api'
Types namespace Api
Base path /api/v2
Pinned API version 2026-09-24
Resource types 7
Planning Center docs Planning Center API API

Each product client sends X-PCO-API-Version: 2026-09-24, the version these types were generated from. Override it with new PlanningCenter({ auth, versions: { api: '...' } }); the types won’t follow. See Products.

import { createApiClient } from '@mackenly/planningcenterkit/api';

const api = createApiClient({ auth: { applicationId: process.env.PCO_APP_ID!, secret: process.env.PCO_SECRET! } });
const { data: root } = await api.get(); // /api/v2

Root collections

Properties on pco.api, named after their URL. pco.api.get() fetches the product root (/api/v2), and pco.api.edge(name) follows any root edge by name.

Client path Resource Returns Filters Create
pco.api.connected_applications ConnectedApplication Collection No
pco.api.oauth_applications OauthApplication Collection No
pco.api.personal_access_tokens PersonalAccessToken Collection accessible No

Resources

Resource TypeScript Description
ConnectedApplication Api.ConnectedApplication
ConnectedApplicationPerson Api.ConnectedApplicationPerson
OauthApplication Api.OauthApplication
OauthApplicationMau Api.OauthApplicationMau Monthly Active Users for an Oauth Application.
Organization Api.Organization
Person Api.Person
PersonalAccessToken Api.PersonalAccessToken

Type to search…

↑↓ navigate↵ selectEsc close