Skip to content

PersonalAccessToken (API)

The PersonalAccessToken resource in Planning Center API: how to reach it, its attributes, and what you can query and write.

Property Value
Product API (pco.api, API version 2026-09-24)
Resource type PersonalAccessToken
TypeScript Api.PersonalAccessToken, attributes Api.PersonalAccessTokenAttributes, schema Api.PersonalAccessTokenSchema
Planning Center path /api/v2/personal_access_tokens
Planning Center docs PersonalAccessToken

How to reach it

Client path Returns Filters Create
pco.api.personal_access_tokens Collection accessible No

From a collection, .id(personalAccessTokenId) addresses one PersonalAccessToken: pco.api.personal_access_tokens.id(personalAccessTokenId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Api.PersonalAccessTokenAttributes. Every resource also has id and type ('PersonalAccessToken') next to its attributes.

Name Type Description
created_at string | null
last_used_on string | null The day this token was last used to make an api request, or null if it never has.
name string | null
revoked_at string | null When the token was revoked, or null while it is still usable.

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): person.

Relationship Type To Includable
person To one Person Yes

Querying

No documented where fields.

Order

order(...) accepts these fields, ascending, or descending with a - prefix: created_at, last_used_on, name, person, revoked_at.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
pco.api.personal_access_tokens accessible

Edges

Follow these from one PersonalAccessToken, ref = pco.api.personal_access_tokens.id(personalAccessTokenId):

Edge Leads to Returns Filters Create
ref.person Person Collection No

Writing

Property Value
Create No
Update No
Delete No

Actions

Run with ref.action(name, body?). Bodies are untyped: see Planning Center’s docs for each action.

Action Path Description
revoke POST /api/v2/personal_access_tokens/{personal_access_token_id}/revoke Revokes a personal access token

Example

import type { Api } from '@mackenly/planningcenterkit';

const page = await pco.api.personal_access_tokens.order('created_at').perPage(25).list();
const items: Api.PersonalAccessToken[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close