Skip to content

Location (Groups)

A physical event location

A physical event location

Property Value
Product Groups (pco.groups, API version 2026-11-10)
Resource type Location
TypeScript Groups.Location, attributes Groups.LocationAttributes, schema Groups.LocationSchema
Planning Center path /groups/v2/events/{event_id}/location
Planning Center docs Location

How to reach it

Client path Returns Filters Create
pco.groups.events.id(eventId).location Collection No
pco.groups.groups.id(groupId).location Collection No

From a collection, .id(locationId) addresses one Location: pco.groups.events.id(eventId).location.id(locationId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Groups.LocationAttributes. Every resource also has id and type ('Location') next to its attributes.

Name Type Description
display_preference string | null See details.
full_formatted_address string | null Ex: “1313 Disneyland Dr Anaheim, CA 92802” (may be approximate or null) Approximate address would be “Anaheim, CA 92802”. We obscure Canadian zip codes.
latitude number | null Ex: 33.815396 (may be approximate or null)
longitude number | null Ex: -117.926399 (may be approximate or null)
name string | null Ex: “Disneyland”
radius string | null The number of miles in a location’s approximate address. Will be 0 if the strategy is exact, and will be null if the strategy is hidden.
strategy string | null The display preference strategy used for the current request, based on user permissions. Either hidden, approximate, or exact.

Attribute details

display_preference

This preference controls how the location is displayed to non-members for public groups and events.

Possible values: hidden, approximate, or exact

Relationships and includes

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

Relationship Type To Includable
group To one Group Yes

Querying

No documented where fields.

No documented order fields.

Edges

Follow these from one Location, ref = pco.groups.events.id(eventId).location.id(locationId):

Edge Leads to Returns Filters Create
ref.group Group Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const eventId = '1'; // Event id

const page = await pco.groups.events.id(eventId).location.perPage(25).list();
const items: Groups.Location[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close