ScheduledPerson - Services API

Example Request

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

View in API Explorer →

Example Object

{
  "type": "ScheduledPerson",
  "id": "1",
  "attributes": {
    "full_name": "string",
    "status": "string",
    "thumbnail": "string"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "signup_sheet": {
      "data": {
        "type": "SignupSheet",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`full_name`	`string`
`id`	`primary_key`
`status`	`string`
`thumbnail`	`string`

Relationships

Name	Type	Association Type	Note
person	Person	to_one
signup_sheet	SignupSheet	to_one

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/{signup_sheet_id}/scheduled_people`

Reading

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

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/{signup_sheet_id}/scheduled_people`	SignupSheet