Skip to content

MaritalStatus (People)

A martial status represents a member's current status, e.g.

A martial status represents a member’s current status, e.g. married, single, etc.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type MaritalStatus
TypeScript People.MaritalStatus, attributes People.MaritalStatusAttributes, schema People.MaritalStatusSchema
Planning Center path /people/v2/marital_statuses
Planning Center docs MaritalStatus

How to reach it

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

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

Attributes

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

Name Type Description
value string | null

Querying

Where

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

Field Value type Operators
value string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: sequence, value.

Edges

This resource has no documented edges.

Writing

Property Value
Create Yes, create() on pco.people.marital_statuses
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as People.MaritalStatusSchema['create'].

Attribute Type
value string | null

Update attributes

Typed as People.MaritalStatusSchema['update'].

Attribute Type
value string | null

See Writing data.

Example

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

const page = await pco.people.marital_statuses.order('sequence').perPage(25).list();
const items: People.MaritalStatus[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close