Skip to content

SocialProfile (People)

A social profile represents a members's Twitter, Facebook, or other social media account.

A social profile represents a members’s Twitter, Facebook, or other social media account.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type SocialProfile
TypeScript People.SocialProfile, attributes People.SocialProfileAttributes, schema People.SocialProfileSchema
Planning Center path /people/v2/social_profiles
Planning Center docs SocialProfile

How to reach it

Client path Returns Filters Create
pco.people.social_profiles Collection No
pco.people.people.id(personId).social_profiles Collection Yes

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

Attributes

On People.SocialProfileAttributes. Every resource also has id and type ('SocialProfile') next to its attributes.

Name Type Description
created_at string | null
site string | null
updated_at string | null
url string | null
verified boolean | null

Relationships and includes

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

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
site string Equality only
updated_at string | Date gt, gte, lt, lte
url string Equality only
verified boolean Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: created_at, site, updated_at, url, verified.

Edges

Follow these from one SocialProfile, ref = pco.people.social_profiles.id(socialProfileId):

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

Writing

Property Value
Create Yes, create() on social_profiles on Person
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as People.SocialProfileSchema['create'].

Attribute Type
site string | null
url string | null
verified boolean | null

Update attributes

Typed as People.SocialProfileSchema['update'].

Attribute Type
site string | null
url string | null
verified boolean | null

See Writing data.

Example

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

const page = await pco.people.social_profiles.order('created_at').perPage(25).list();
const items: People.SocialProfile[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close