---
title: "Location (Check-Ins)"
description: "A place where people may check in to for a given event."
---

> Documentation Index
> Fetch the complete documentation index at: https://planningcenterkit.mackenly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Location (Check-Ins)

A place where people may check in to for a given event.
Some locations have `kind="Folder"`, which means that people
can't check-in here, but this location contains other locations.
You can get its contents from the `locations` attribute.
You can get a location's parent folder from the `parent` attribute.
(If it's not in a folder, `parent` will be empty.)

| Property | Value |
| --- | --- |
| Product | [Check-Ins](/reference/check-ins/) (`pco.checkIns`, API version `2025-05-28`) |
| Resource type | `Location` |
| TypeScript | `CheckIns.Location`, attributes `CheckIns.LocationAttributes`, schema `CheckIns.LocationSchema` |
| Planning Center path | `/check-ins/v2/check_ins/{check_in_id}/locations` |
| Planning Center docs | [Location](https://api.planningcenteronline.com/docs/apps/check-ins/versions/2025-05-28/vertices/location) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.checkIns.check_ins.id(checkInId).locations` | Collection |  | No |
| `pco.checkIns.events.id(eventId).locations` | Collection | `locations`, `root` | No |
| `pco.checkIns.event_times.id(eventTimeId).available_locations` | Collection |  | No |
| `pco.checkIns.check_ins.id(checkInId).locations.id(locationId).locations` | Collection |  | No |
| `pco.checkIns.check_ins.id(checkInId).locations.id(locationId).parent` | Collection |  | No |
| `pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId).location_event_periods.id(locationEventPeriodId).location` | Collection |  | No |
| `pco.checkIns.event_times.id(eventTimeId).location_event_times.id(locationEventTimeId).location` | Collection |  | No |
| `pco.checkIns.labels.id(labelId).location_labels.id(locationLabelId).location` | Collection |  | No |
| `pco.checkIns.stations.id(stationId).location` | Collection |  | No |

From a collection, `.id(locationId)` addresses one Location: `pco.checkIns.check_ins.id(checkInId).locations.id(locationId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

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

| Name | Type | Description |
| --- | --- | --- |
| `age_max_in_months` | `number \| null` |  |
| `age_min_in_months` | `number \| null` |  |
| `age_on` | `string \| null` |  |
| `age_range_by` | `string \| null` |  |
| `attendees_per_volunteer` | `number \| null` |  |
| `child_or_adult` | `string \| null` |  |
| `created_at` | `string \| null` |  |
| `effective_date` | `string \| null` |  |
| `gender` | `string \| null` |  |
| `grade_max` | `number \| null` |  |
| `grade_min` | `number \| null` |  |
| `kind` | `string \| null` |  |
| `max_occupancy` | `number \| null` |  |
| `milestone` | `string \| null` |  |
| `min_volunteers` | `number \| null` |  |
| `name` | `string \| null` |  |
| `opened` | `boolean \| null` |  |
| `position` | `number \| null` |  |
| `questions` | `string \| null` |  |
| `updated_at` | `string \| null` |  |

## Relationships and includes

Side-load with `include()` (or `get({ include })`) and read with `related(resource, name)`: `event`, `locations`, `options`, `parent`.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `parent` | To one | `Parent` | Yes |

## Querying

No documented `where` fields.

### Order

`order(...)` accepts these fields, ascending, or descending with a `-` prefix: `kind`, `name`, `position`.

### Filters

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

| Edge | Filters |
| --- | --- |
| `locations` on [Event](/reference/check-ins/event/) | `locations`, `root` |

## Edges

Follow these from one Location, `ref = pco.checkIns.check_ins.id(checkInId).locations.id(locationId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.check_ins` | [CheckIn](/reference/check-ins/check-in/) | Collection | `attendee`, `checked_out`, `first_time`, `guest`, `not_checked_out`, `not_one_time_guest`, `one_time_guest`, `regular`, `volunteer` | No |
| `ref.event` | [Event](/reference/check-ins/event/) | Collection |  | No |
| `ref.integration_links` | [IntegrationLink](/reference/check-ins/integration-link/) | Collection |  | No |
| `ref.location_event_periods` | [LocationEventPeriod](/reference/check-ins/location-event-period/) | Collection |  | No |
| `ref.location_event_times` | [LocationEventTime](/reference/check-ins/location-event-time/) | Collection |  | No |
| `ref.location_labels` | [LocationLabel](/reference/check-ins/location-label/) | Collection |  | No |
| `ref.locations` | [Location](/reference/check-ins/location/) | Collection |  | No |
| `ref.options` | [Option](/reference/check-ins/option/) | Collection |  | No |
| `ref.parent` | [Location](/reference/check-ins/location/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | No |
| Update | No |
| Delete | No |

## Example

```ts
import type { CheckIns } from '@mackenly/planningcenterkit';

const checkInId = '1'; // CheckIn id

const page = await pco.checkIns.check_ins.id(checkInId).locations.order('kind').perPage(25).list();
const items: CheckIns.Location[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/check-ins/location/index.mdx
