---
title: "SignupSheetMetadata (Services)"
description: "A SignupSheetMetadata Resource"
---

> 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.

# SignupSheetMetadata (Services)

A SignupSheetMetadata Resource

| Property | Value |
| --- | --- |
| Product | [Services](/reference/services/) (`pco.services`, API version `2018-11-01`) |
| Resource type | `SignupSheetMetadata` |
| TypeScript | `Services.SignupSheetMetadata`, attributes `Services.SignupSheetMetadataAttributes`, schema `Services.SignupSheetMetadataSchema` |
| Planning Center path | `/services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets/{signup_sheet_id}/signup_sheet_metadata` |
| Planning Center docs | [SignupSheetMetadata](https://api.planningcenteronline.com/docs/apps/services/versions/2018-11-01/vertices/signup_sheet_metadata) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.services.people.id(personId).available_signups.id(availableSignupId).signup_sheets.id(signupSheetId).signup_sheet_metadata` | Collection |  | No |

From a collection, `.id(signupSheetMetadataId)` addresses one SignupSheetMetadata: `pco.services.people.id(personId).available_signups.id(availableSignupId).signup_sheets.id(signupSheetId).signup_sheet_metadata.id(signupSheetMetadataId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `Services.SignupSheetMetadataAttributes`. Every resource also has `id` and `type` (`'SignupSheetMetadata'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `conflicts` | `Record<string, unknown> \| null` |  |
| `ends_at` | `string \| null` |  |
| `starts_at` | `string \| null` |  |
| `time_name` | `string \| null` |  |
| `time_type` | `string \| null` |  |

## Relationships and includes

Planning Center documents no includes for this resource.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `plan_time` | To one | [PlanTime](/reference/services/plan-time/) | No |

## Querying

No documented `where` fields.

No documented `order` fields.

## Edges

This resource has no documented edges.

## Writing

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

## Example

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

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

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

Source: https://planningcenterkit.mackenly.com/reference/services/signup-sheet-metadata/index.mdx
