API
⌘K
My Developer Account

Signup

A Signup is an organization signup that people can register for.

Example Request 

curl https://api.planningcenteronline.com/registrations/v2/signups

View in API Explorer →

Example Object 

{
  "type": "Signup",
  "id": "1",
  "attributes": {
    "archived": true,
    "close_at": "2000-01-01T12:00:00Z",
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "logo_url": "string",
    "name": "string",
    "new_registration_url": "string",
    "open_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name Type Description
archived boolean

Whether the signup is archived or not.
close_at date_time

UTC time at which regsitration closes.
created_at date_time
description string

Decription of the signup.
id primary_key
logo_url string

URL for the image used for the signup.
name string

Name of the signup.
new_registration_url string

URL to allow people to register for signup.
open_at date_time

UTC time at which regsitration opens.
updated_at date_time

Can Include

Parameter Value Description Assignable
include campuses

include associated campuses
include categories

include associated categories
include next_signup_time

include associated nextsignuptime
include signup_location

include associated signup_location
include signup_times

include associated signup_times

Query By

Name Parameter Type Description Example
id where[id] primary_key

Query on a specific id

 ?where[id]=primary_key

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 /registrations/v2/signups

Notes:

Organization admins can see all signups. Signup managers can only see the signups they manage.

Reading

HTTP Method Endpoint
GET /registrations/v2/signups/{id}

Notes:

Organization admins can see all signups. Signup managers can only see the signups they manage.

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/attendees Attendee
  • active
  • canceled
  • waitlist
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/campuses Campus
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/categories Category
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/next_signup_time SignupTime
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/registrations Registration
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/selection_types SelectionType
  • publicly_available
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/signup_location SignupLocation
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/signup_times SignupTime
  • future
  • past

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/registrations/v2/signups Organization
  • archived
  • unarchived