API
⌘K
My Developer Account

Attendee

An Attendee is a person registered for a signup.

Example Request 

curl https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/attendees

View in API Explorer →

Example Object 

{
  "type": "Attendee",
  "id": "1",
  "attributes": {
    "active": true,
    "canceled": true,
    "complete": true,
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "waitlisted": true,
    "waitlisted_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name Type Description
active boolean

Whether or not the attendee is active.
canceled boolean

Whether or not the attendee is canceled.
complete boolean

Whether or not attendee has completed all necessary items (personal information, questions, forms, add ons).

Only available when requested with the ?fields param
created_at date_time
id primary_key
updated_at date_time
waitlisted boolean

Whether or not the attendee is waitlisted.
waitlisted_at date_time

UTC time at which the attendee was waitlisted.

Can Include

Parameter Value Description Assignable
include emergency_contact

include associated emergency_contact
include person

include associated person
include registration

include associated registration
include selection_type

include associated selection_type

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/{signup_id}/attendees

Notes:

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

Reading

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

Notes:

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/attendees/{attendee_id}/emergency_contact EmergencyContact
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/attendees/{attendee_id}/person Person
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/attendees/{attendee_id}/registration Registration
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/attendees/{attendee_id}/selection_type SelectionType

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/attendees Signup
  • active
  • canceled
  • waitlist