API
⌘K
My Developer Account

SignupSheet

Available positions to sign up for

Example Request

curl https://api.planningcenteronline.com/services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets

View in API Explorer →

Example Object

{
  "type": "SignupSheet",
  "id": "1",
  "attributes": {
    "display_times": "string",
    "group_key": "string",
    "position_name": "string",
    "sort_date": "2000-01-01T12:00:00Z",
    "sort_index": 1,
    "team_name": "string",
    "title": "string"
  },
  "relationships": {
    "plan": {
      "data": {
        "type": "Plan",
        "id": "1"
      }
    },
    "team_position": {
      "data": {
        "type": "TeamPosition",
        "id": "1"
      }
    },
    "team": {
      "data": {
        "type": "Team",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
display_times string
group_key string
id primary_key
position_name string
sort_date date_time
sort_index integer
team_name string
title string

Relationships

Name Type Association Type Note
plan Plan to_one
team_position TeamPosition to_one
team Team to_one

Can Include

Parameter Value Description Assignable
include scheduled_people include associated scheduled_people
include signup_sheet_metadata include associated signup_sheet_metadata

Pagination

Name Parameter Type Description
per_page per_page integer how many records to return per page (min=1, max=100, default=25)
offset offset integer get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets

Reading

HTTP Method Endpoint
GET /services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets/{id}

Actions

HTTP Method Endpoint Description
POST https://api.planningcenteronline.com/services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets/{signup_sheet_id}/accept Accept a signup sheet

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets/{signup_sheet_id}/scheduled_people ScheduledPerson
GET https://api.planningcenteronline.com/services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets/{signup_sheet_id}/signup_sheet_metadata SignupSheetMetadata

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/services/v2/people/{person_id}/available_signups/{available_signup_id}/signup_sheets AvailableSignup