Skip to content

IntegrationLink (Check-Ins)

A record linking another product's resource to a Check-Ins resource.

A record linking another product’s resource to a Check-Ins resource.

Property Value
Product Check-Ins (pco.checkIns, API version 2025-05-28)
Resource type IntegrationLink
TypeScript CheckIns.IntegrationLink, attributes CheckIns.IntegrationLinkAttributes, schema CheckIns.IntegrationLinkSchema
Planning Center path /check-ins/v2/integration_links
Planning Center docs IntegrationLink

How to reach it

Client path Returns Filters Create
pco.checkIns.integration_links Collection No
pco.checkIns.events.id(eventId).integration_links Collection No
pco.checkIns.check_ins.id(checkInId).locations.id(locationId).integration_links Collection No

From a collection, .id(integrationLinkId) addresses one IntegrationLink: pco.checkIns.integration_links.id(integrationLinkId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On CheckIns.IntegrationLinkAttributes. Every resource also has id and type ('IntegrationLink') next to its attributes.

Name Type Description
remote_app string | null
remote_gid string | null The Global ID for the external resource. Formatted as gid://<app>/<type>/<id>.
remote_id string | null
remote_type string | null
sync_future_assignment_types boolean | null

Relationships and includes

Planning Center documents no includes for this resource.

Relationship Type To Includable
local To one Event No

Querying

Where

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

Field Value type Operators
remote_gid string Equality only

No documented order fields.

Edges

This resource has no documented edges.

Writing

Property Value
Create No
Update No
Delete No

Example

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

const page = await pco.checkIns.integration_links.perPage(25).list();
const items: CheckIns.IntegrationLink[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close