Skip to content

SignupSheet (Services)

Available positions to sign up for

Available positions to sign up for

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type SignupSheet
TypeScript Services.SignupSheet, attributes Services.SignupSheetAttributes, schema Services.SignupSheetSchema
Planning Center path /services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets
Planning Center docs SignupSheet

How to reach it

Client path Returns Filters Create
pco.services.people.id(personId).available_signups.id(availableSignupId).signup_sheets Collection No

From a collection, .id(signupSheetId) addresses one SignupSheet: pco.services.people.id(personId).available_signups.id(availableSignupId).signup_sheets.id(signupSheetId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Services.SignupSheetAttributes. Every resource also has id and type ('SignupSheet') next to its attributes.

Name Type Description
display_times string | null
group_key string | null
plan_title string | null
position_name string | null
sort_date string | null
sort_index number | null
team_name string | null
title string | null

Relationships and includes

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

Relationship Type To Includable
plan To one Plan No
team To one Team No
team_position To one TeamPosition No

Querying

No documented where fields.

No documented order fields.

Edges

Follow these from one SignupSheet, ref = pco.services.people.id(personId).available_signups.id(availableSignupId).signup_sheets.id(signupSheetId):

Edge Leads to Returns Filters Create
ref.scheduled_people ScheduledPerson Collection No
ref.signup_sheet_metadata SignupSheetMetadata Collection No

Writing

Property Value
Create No
Update No
Delete No

Actions

Run with ref.action(name, body?). Bodies are untyped: see Planning Center’s docs for each action.

Action Path Description
accept POST /services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets/{signup_sheet_id}/accept Accept a signup sheet

Example

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

const personId = '1'; // Person id
const availableSignupId = '1'; // AvailableSignup id

const page = await pco.services.people.id(personId).available_signups.id(availableSignupId).signup_sheets.perPage(25).list();
const items: Services.SignupSheet[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close