Skip to content

Person (Calendar)

The people in your organization with access to Calendar.

The people in your organization with access to Calendar.

Property Value
Product Calendar (pco.calendar, API version 2026-06-22)
Resource type Person
TypeScript Calendar.Person, attributes Calendar.PersonAttributes, schema Calendar.PersonSchema
Planning Center path /calendar/v2/people
Planning Center docs Person

How to reach it

Client path Returns Filters Create
pco.calendar.people Collection active, event_owners No
pco.calendar.conflicts.id(conflictId).resolved_by Collection No
pco.calendar.events.id(eventId).owner Collection No
pco.calendar.event_resource_requests.id(eventResourceRequestId).created_by Collection No
pco.calendar.event_resource_requests.id(eventResourceRequestId).updated_by Collection No
pco.calendar.resource_approval_groups.id(resourceApprovalGroupId).people Collection No

From a collection, .id(personId) addresses one Person: pco.calendar.people.id(personId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Calendar.PersonAttributes. Every resource also has id and type ('Person') next to its attributes.

Name Type Description
avatar_url string | null Path to where the avatar image is stored
can_edit_people boolean | null Indicates whether the person can edit other people
can_edit_resources boolean | null Indicates whether the person can edit resources
can_edit_rooms boolean | null Indicates whether the person can edit rooms
child boolean | null Indicates whether the person is a child
contact_data string | null See details.
created_at string | null UTC time at which the person was created
event_administrator boolean | null See details.
event_permissions_type string | null Event permissions for the person
first_name string | null The person’s first name
gender string | null M indicates male, F indicates female
has_access boolean | null Indicates whether the person has access to Calendar
has_full_access_to_any_calendar boolean | null See details.
last_name string | null The person’s last name
member_of_approval_groups boolean | null See details.
middle_name string | null The person’s middle name
name string | null The person’s first name, last name, and name suffix
name_prefix string | null See details.
name_suffix string | null See details.
pending_request_count number | null See details.
people_permissions_type string | null People permissions for the person
permissions number | null Integer that corresponds to the person’s permissions in Calendar
resolves_conflicts boolean | null Indicates whether the person is able to resolve Conflicts
resources_permissions_type string | null Resource permissions for the person
room_permissions_type string | null Room permissions for the person
site_administrator boolean | null Indicates whether the person is a Organization Administrator
status string | null See details.
updated_at string | null UTC time at which the person was updated

Attribute details

contact_data

An object containing the person’s contact data.

This can include an array of email_addresses, addresses and phone_numbers

event_administrator

Indicates whether the person is an Event Administrator, and therefore has access to every calendar

Only available when requested with the ?fields param

has_full_access_to_any_calendar

Indicates whether the person has full (not limited, event-level-only) access to at least one calendar

Only available when requested with the ?fields param

member_of_approval_groups

Indicates whether the person is a member of at least one approval group

Only available when requested with the ?fields param

name_prefix

Possible values:

  • Mr.
  • Mrs.
  • Ms.
  • Miss
  • Dr.
  • Rev.

name_suffix

Possible values:

  • Jr.
  • Sr.
  • Ph.D.
  • II
  • III

pending_request_count

If the person is a member of an approval group, the number of EventResourceRequests needing resolution.

If resolves_conflicts is true, the count will also include the number of Conflicts needing resolution.

status

Possible values:

  • active: The person is marked “active” in People
  • inactive: The person is marked “inactive” in People

Possible values: active, pending, or inactive

Relationships and includes

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

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
created_at string | Date gt, gte, lt, lte
first_name string Equality only
last_name string Equality only
middle_name string Equality only
updated_at string | Date gt, gte, lt, lte

Order

order(...) accepts these fields, ascending, or descending with a - prefix: created_at, first_name, last_name, resolves_conflicts, updated_at.

Filters

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

Edge Filters
pco.calendar.people active, event_owners

Edges

Follow these from one Person, ref = pco.calendar.people.id(personId):

Edge Leads to Returns Filters Create
ref.event_resource_requests EventResourceRequest Collection awaiting_response, future, not_in_conflict, not_overbooked, overbooked No
ref.organization Organization Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const page = await pco.calendar.people.order('created_at').perPage(25).list();
const items: Calendar.Person[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close