AvailableSignup - Services API

Example Request

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

View in API Explorer →

Example Object

{
  "type": "AvailableSignup",
  "id": "1",
  "attributes": {
    "organization_name": "string",
    "planning_center_url": "string",
    "service_type_name": "string",
    "signups_available": true
  },
  "relationships": {
    "organization": {
      "data": {
        "type": "Organization",
        "id": "1"
      }
    },
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "service_type": {
      "data": {
        "type": "ServiceType",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`id`	`primary_key`
`organization_name`	`string`
`planning_center_url`	`string`
`service_type_name`	`string`
`signups_available`	`boolean`

Relationships

Name	Type	Association Type
organization	Organization	to_one
person	Person	to_one
service_type	ServiceType	to_one

Can Include

Parameter	Value	Description	Assignable
include	signup_sheets	include associated signup_sheets

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`

Reading

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

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`	SignupSheet

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/people/{person_id}/available_signups`	Person		`current_organization`