Pushpay / Church Community Builder
App · 20 actions
Read and manage church events and families using Pushpay ChMS API v2.
Actions
| Action | What it does |
|---|---|
| Create event | Create event. |
| Create family | Create family. |
| Delete event | Delete event. |
| Get church | Get current church information. |
| Get event | Get event information. |
| Get event attendance | Get event summary details. |
| Get event calendar | Get the event calendar. |
| Get event occurrence | Get a specific occurrence of an event. |
| Get family | Get family. |
| List campuses | Get campus list. |
| List event attendees | Get event attendees list. |
| List event candidates | Get event candidate list. |
| List event guests | Get event guest list. |
| List event resources | Get event resource list. |
| List event rooms | Get event room list. |
| List events | Get event list. |
| List families | Get families. |
| Search events | Search events. |
| Update event | Update event. |
| Update family | Update family. |
Create event
Create event.
Inputs
- All day
all_daytrue/false - All day.
- Approval status id
approval_status_idnumber - Approval status id.
- Cleanup
cleanupdate and time - Cleanup.
- Confirm change
confirm_changetrue/false - To confirm if a change is being "forced" (overiding any warnding) set to true.
- Description
descriptiontext - Description.
- End
enddate and timeRequired - End.
- Group id
group_idnumberRequired - Group id.
- Name
nametextRequired - Name.
- Occurrence
occurrencetext - Occurrence.
- Owner id
owner_idnumber - Owner id.
- Setup
setupdate and time - Setup.
- Start
startdate and timeRequired - Start.
- Type id
type_idnumber - Require leader approval or form response to get on the guest list
- Uses resources
uses_resourcestrue/false - Uses resources.
- Phone
phonetext - Phone.
- Location name
location_nametext - Location name.
- Location street
location_streettext - Location street.
- Location city
location_citytext - Location city.
- Location state
location_statetext - Location state.
- Location zip
location_ziptext - Location zip.
- Apply changes to
apply_changes_totext - Apply changes to.One of:
ONLY_THIS_DATE(Only this date),THIS_AND_FUTURE_DATES(This and future dates),ALL_DATES(All dates). - Recurs
recurstrue/false - Recurs.
- Recur end date
recur_end_datedate and time - Recur end date.
- Recur frequency
recur_frequencytext - Daily = D | Weekly = W | Monthly by Day = MO | Monthly by Date = MPOne of:
D,W,MO,MP. - Recur interval
recur_intervalnumber - Recur interval.
- Recur freq modifier
recur_freq_modifiertext - Recur freq modifier.One of:
SU,MO,TU,WE,TH,FR,SA. - Attend max quantity
attend_max_quantitynumber - Attend max quantity.
- Checkin label quantity
checkin_label_quantitynumber - Checkin label quantity.
- Checkin label type
checkin_label_typetext - Checkin label type.One of:
NONE,NAME,SECURE. - Grouping id
grouping_idnumber - Grouping id.
- Room description
room_descriptiontext - Room description.
- Room ratio
room_rationumber - Room ratio.
- Checkin type
checkin_typetext - Checkin type.One of:
NONE,CHECKIN,PRECHECK,INSTANT. - Checkin announcement
checkin_announcementobject - Checkin announcement.
Outputs
dataobject- Service response.
Example output
{
"data": {
"actions": {
"can_edit": {
"allowed": false,
"reasons": []
},
"can_view_guest_list": {
"allowed": false,
"reasons": []
}
},
"address": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"all_day": false,
"approval_status": "example",
"approval_status_id": 1,
"attend_max_quantity": "example",
"attendance": {
"occurrence_has": false,
"occurrence_has_after": false,
"occurrence_has_before": false,
"occurrence_last_with": "2026-11-01T12:00:00Z"
},
"campus_id": 1,
"checkin": {
"announcement": {
"body": "example",
"source": "EVENT",
"source_id": 1,
"title": "example"
},
"attend_max_quantity": 1,
"checkin_label_quantity": 1,
"checkin_label_type": "NONE",
"checkin_type": "NONE",
"grouping_id": 1,
"room_description": "example",
"room_ratio": 1
},
"checkin_label_quantity": 1,
"checkin_label_type": "NONE",
"cleanup": "2026-11-01T12:00:00Z",
"creator": {
"active": false,
"addresses": {
"home": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"mailing": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"work": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
}
},
"approval_status_modifier_id": "example",
"birthday": "2026-11-01",
"campus_id": 1,
"created": "2026-11-01",
"date_child_work_start": "2026-11-01",
"date_child_work_stop": "2026-11-01",
"deceased": "2026-11-01",
"denied_status_reason": "example",
"email": "example",
"email_unsubscribed": false,
"email_unsubscribed_reason": "API_UNSUBSCRIBED",
"family_id": 1,
"family_position": "PRIMARY_CONTACT",
"first_name": "example",
"gender": "MALE",
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"is_child_work_approved": false,
"last_name": "example",
"legal_first_name": "example",
"marital_status": "MARRIED",
"membership_type_id": 1,
"middle_name": "example",
"name": "example",
"name_prefix": "example",
"name_suffix": "example",
"phone": {
"fax": "example",
"home": "example",
"mobile": "example",
"mobile_carrier_id": "example",
"pager": "example",
"work": "example"
},
"preferred_number": "HOME"
},
"date_created": "2026-11-01T12:00:00Z",
"date_modified": "2026-11-01T12:00:00Z",
"description": "example",
"end": "2026-11-01T12:00:00Z",
"estimated_attendance": "example",
"group": {
"campus_id": 1,
"coach_id": 1,
"department": {
"id": 1
},
"director_id": 1,
"group_type": {
"id": 1,
"name": "example"
},
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"inactive": false,
"interaction_type": "MEMBERS_INTERACT",
"is_system_group": false,
"main_leader": {
"actions": {
"can_view_profile": {}
},
"email": "example",
"first_name": "example",
"id": 1,
"last_name": "example",
"name": "example"
},
"membership_type": "OPEN_TO_ALL",
"name": "example",
"owner_id": 1,
"public_signup_form": {
"actions": {
"can_edit_form": {},
"can_respond_to_form": {},
"can_view_form": {}
},
"campus_id": 1,
"description": "example",
"end": "2026-11-01T12:00:00Z",
"id": 1,
"manager_count": 1,
"public": false,
"start": "2026-11-01T12:00:00Z",
"status": "ACTIVE",
"title": "example",
"url": "example"
}
},
"guest_counts": {
"going": 1,
"maybe": 1,
"not_going": 1,
"not_responded": 1,
"requesting": 1
},
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"invitation_settings": {
"allow_additional_guests": false,
"attend_max_quantity": 1,
"notify_owner_of_status_changes": false,
"show_guest_list": false
},
"modifier": {
"active": false,
"addresses": {
"home": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"mailing": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"work": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
}
},
"approval_status_modifier_id": "example",
"birthday": "2026-11-01",
"campus_id": 1,
"created": "2026-11-01",
"date_child_work_start": "2026-11-01",
"date_child_work_stop": "2026-11-01",
"deceased": "2026-11-01",
"denied_status_reason": "example",
"email": "example",
"email_unsubscribed": false,
"email_unsubscribed_reason": "API_UNSUBSCRIBED",
"family_id": 1,
"family_position": "PRIMARY_CONTACT",
"first_name": "example",
"gender": "MALE",
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"is_child_work_approved": false,
"last_name": "example",
"legal_first_name": "example",
"marital_status": "MARRIED",
"membership_type_id": 1,
"middle_name": "example",
"name": "example",
"name_prefix": "example",
"name_suffix": "example",
"phone": {
"fax": "example",
"home": "example",
"mobile": "example",
"mobile_carrier_id": "example",
"pager": "example",
"work": "example"
},
"preferred_number": "HOME"
},
"name": "example",
"next_occurrence": {
"end": "2026-11-01T12:00:00Z",
"occurrence": "example",
"start": "2026-11-01T12:00:00Z"
},
"owner": {
"active": false,
"addresses": {
"home": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"mailing": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"work": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
}
},
"approval_status_modifier_id": "example",
"birthday": "2026-11-01",
"campus_id": 1,
"created": "2026-11-01",
"date_child_work_start": "2026-11-01",
"date_child_work_stop": "2026-11-01",
"deceased": "2026-11-01",
"denied_status_reason": "example",
"email": "example",
"email_unsubscribed": false,
"email_unsubscribed_reason": "API_UNSUBSCRIBED",
"family_id": 1,
"family_position": "PRIMARY_CONTACT",
"first_name": "example",
"gender": "MALE",
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"is_child_work_approved": false,
"last_name": "example",
"legal_first_name": "example",
"marital_status": "MARRIED",
"membership_type_id": 1,
"middle_name": "example",
"name": "example",
"name_prefix": "example",
"name_suffix": "example",
"phone": {
"fax": "example",
"home": "example",
"mobile": "example",
"mobile_carrier_id": "example",
"pager": "example",
"work": "example"
},
"preferred_number": "HOME"
},
"phone": "example",
"recur_end_date": "2026-11-01T12:00:00Z",
"recurrence": {
"end": "2026-11-01",
"frequency": "example",
"frequency_modifier": "example",
"interval": 1
},
"recurs": false,
"registration": {
"closed": false,
"form_id": 1,
"url": "example"
},
"room_description": "example",
"room_ratio": "example",
"setup": "2026-11-01T12:00:00Z",
"setup_notes": "example",
"start": "2026-11-01T12:00:00Z",
"type_id": 1,
"use_campus_address": false,
"uses_resources": false
}
}Create family
Create family.
Inputs
- Individual id
individual_idnumber - When provided, will create a new family with this individual as the primary contact (all other fields ignored)
- Last name
last_nametextRequired - Last name.
- Campus id
campus_idnumber - Campus id.
- Address
addressobject - Address.
- Message
messagetext - valid only when can_edit_checkin_message is TRUE
- Phone
phonetext - Phone.
- Members
memberslist - Members.
Outputs
dataobject- Service response.
Example output
{
"data": {
"actions": {},
"address": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"authorized_individuals": [],
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"last_name": "example",
"members": [],
"message": "example",
"messages": []
}
}Delete event
Delete event.
Inputs
- Id
idnumberRequired - Id.
Outputs
dataobject- Service response.
Example output
{
"data": {}
}Get church
Get current church information.
Inputs
None.
Outputs
dataobject- Service response.
Example output
{
"data": {
"api_base_url": "example",
"base_url": "example",
"features": [],
"id": 1,
"is_fake": false,
"master_ecg_id": "example",
"name": "example",
"public_find_group_name": "example",
"subdomain": "example",
"urls": {},
"welcomeText": "example"
}
}Get event
Get event information.
Inputs
- Id
idnumberRequired - Id.
- Occurrence
occurrencetext - Occurrence.
- Attendance info
attendance_infotrue/false - Attendance info.
Outputs
dataobject- Service response.
Example output
{
"data": {
"actions": {
"can_edit": {
"allowed": false,
"reasons": []
},
"can_view_guest_list": {
"allowed": false,
"reasons": []
}
},
"address": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"all_day": false,
"approval_status": "example",
"approval_status_id": 1,
"attend_max_quantity": "example",
"attendance": {
"occurrence_has": false,
"occurrence_has_after": false,
"occurrence_has_before": false,
"occurrence_last_with": "2026-11-01T12:00:00Z"
},
"campus_id": 1,
"checkin": {
"announcement": {
"body": "example",
"source": "EVENT",
"source_id": 1,
"title": "example"
},
"attend_max_quantity": 1,
"checkin_label_quantity": 1,
"checkin_label_type": "NONE",
"checkin_type": "NONE",
"grouping_id": 1,
"room_description": "example",
"room_ratio": 1
},
"checkin_label_quantity": 1,
"checkin_label_type": "NONE",
"cleanup": "2026-11-01T12:00:00Z",
"creator": {
"active": false,
"addresses": {
"home": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"mailing": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"work": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
}
},
"approval_status_modifier_id": "example",
"birthday": "2026-11-01",
"campus_id": 1,
"created": "2026-11-01",
"date_child_work_start": "2026-11-01",
"date_child_work_stop": "2026-11-01",
"deceased": "2026-11-01",
"denied_status_reason": "example",
"email": "example",
"email_unsubscribed": false,
"email_unsubscribed_reason": "API_UNSUBSCRIBED",
"family_id": 1,
"family_position": "PRIMARY_CONTACT",
"first_name": "example",
"gender": "MALE",
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"is_child_work_approved": false,
"last_name": "example",
"legal_first_name": "example",
"marital_status": "MARRIED",
"membership_type_id": 1,
"middle_name": "example",
"name": "example",
"name_prefix": "example",
"name_suffix": "example",
"phone": {
"fax": "example",
"home": "example",
"mobile": "example",
"mobile_carrier_id": "example",
"pager": "example",
"work": "example"
},
"preferred_number": "HOME"
},
"date_created": "2026-11-01T12:00:00Z",
"date_modified": "2026-11-01T12:00:00Z",
"description": "example",
"end": "2026-11-01T12:00:00Z",
"estimated_attendance": "example",
"group": {
"campus_id": 1,
"coach_id": 1,
"department": {
"id": 1
},
"director_id": 1,
"group_type": {
"id": 1,
"name": "example"
},
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"inactive": false,
"interaction_type": "MEMBERS_INTERACT",
"is_system_group": false,
"main_leader": {
"actions": {
"can_view_profile": {}
},
"email": "example",
"first_name": "example",
"id": 1,
"last_name": "example",
"name": "example"
},
"membership_type": "OPEN_TO_ALL",
"name": "example",
"owner_id": 1,
"public_signup_form": {
"actions": {
"can_edit_form": {},
"can_respond_to_form": {},
"can_view_form": {}
},
"campus_id": 1,
"description": "example",
"end": "2026-11-01T12:00:00Z",
"id": 1,
"manager_count": 1,
"public": false,
"start": "2026-11-01T12:00:00Z",
"status": "ACTIVE",
"title": "example",
"url": "example"
}
},
"guest_counts": {
"going": 1,
"maybe": 1,
"not_going": 1,
"not_responded": 1,
"requesting": 1
},
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"invitation_settings": {
"allow_additional_guests": false,
"attend_max_quantity": 1,
"notify_owner_of_status_changes": false,
"show_guest_list": false
},
"modifier": {
"active": false,
"addresses": {
"home": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"mailing": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"work": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
}
},
"approval_status_modifier_id": "example",
"birthday": "2026-11-01",
"campus_id": 1,
"created": "2026-11-01",
"date_child_work_start": "2026-11-01",
"date_child_work_stop": "2026-11-01",
"deceased": "2026-11-01",
"denied_status_reason": "example",
"email": "example",
"email_unsubscribed": false,
"email_unsubscribed_reason": "API_UNSUBSCRIBED",
"family_id": 1,
"family_position": "PRIMARY_CONTACT",
"first_name": "example",
"gender": "MALE",
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"is_child_work_approved": false,
"last_name": "example",
"legal_first_name": "example",
"marital_status": "MARRIED",
"membership_type_id": 1,
"middle_name": "example",
"name": "example",
"name_prefix": "example",
"name_suffix": "example",
"phone": {
"fax": "example",
"home": "example",
"mobile": "example",
"mobile_carrier_id": "example",
"pager": "example",
"work": "example"
},
"preferred_number": "HOME"
},
"name": "example",
"next_occurrence": {
"end": "2026-11-01T12:00:00Z",
"occurrence": "example",
"start": "2026-11-01T12:00:00Z"
},
"owner": {
"active": false,
"addresses": {
"home": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"mailing": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"work": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
}
},
"approval_status_modifier_id": "example",
"birthday": "2026-11-01",
"campus_id": 1,
"created": "2026-11-01",
"date_child_work_start": "2026-11-01",
"date_child_work_stop": "2026-11-01",
"deceased": "2026-11-01",
"denied_status_reason": "example",
"email": "example",
"email_unsubscribed": false,
"email_unsubscribed_reason": "API_UNSUBSCRIBED",
"family_id": 1,
"family_position": "PRIMARY_CONTACT",
"first_name": "example",
"gender": "MALE",
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"is_child_work_approved": false,
"last_name": "example",
"legal_first_name": "example",
"marital_status": "MARRIED",
"membership_type_id": 1,
"middle_name": "example",
"name": "example",
"name_prefix": "example",
"name_suffix": "example",
"phone": {
"fax": "example",
"home": "example",
"mobile": "example",
"mobile_carrier_id": "example",
"pager": "example",
"work": "example"
},
"preferred_number": "HOME"
},
"phone": "example",
"recur_end_date": "2026-11-01T12:00:00Z",
"recurrence": {
"end": "2026-11-01",
"frequency": "example",
"frequency_modifier": "example",
"interval": 1
},
"recurs": false,
"registration": {
"closed": false,
"form_id": 1,
"url": "example"
},
"room_description": "example",
"room_ratio": "example",
"setup": "2026-11-01T12:00:00Z",
"setup_notes": "example",
"start": "2026-11-01T12:00:00Z",
"type_id": 1,
"use_campus_address": false,
"uses_resources": false
}
}Get event attendance
Get event summary details.
Inputs
- Id
idnumberRequired - Id.
- Occurrence
occurrencedateRequired - The occurrence date.
Outputs
dataobject- Service response.
Example output
{
"data": {
"email_sent": "2026-11-01",
"email_to": "example",
"end": "2026-11-01",
"event_id": 1,
"notes": "example",
"occurrence": "example",
"people_information": "example",
"prayer_requests": "example",
"start": "2026-11-01",
"status": "example",
"topic": "example",
"total_attendance": 1,
"visitors": 1
}
}Get event calendar
Get the event calendar.
Inputs
- Id
idnumberRequired - Id.
- Start
startdate - Start.
- End
enddate - End.
Outputs
datalist- Service response.
Example output
{
"data": []
}Get event occurrence
Get a specific occurrence of an event.
Inputs
- Event id
event_idnumberRequired - Event id.
- Occurrence
occurrencedateRequired - Occurrence.
Outputs
datalist- Service response.
Example output
{
"data": []
}Get family
Get family.
Inputs
- Id
idnumberRequired - Id.
- Include deceased
include_deceasedtrue/false - Include deceased.Default:
false. - Include inactive
include_inactivetrue/false - Include inactive.
Outputs
dataobject- Service response.
Example output
{
"data": {
"actions": {},
"address": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"authorized_individuals": [],
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"last_name": "example",
"members": [],
"message": "example",
"messages": []
}
}List campuses
Get campus list.
Inputs
- Location
locationobject - Location.
- Used by groups filter
used_by_groups_filtertext - Used by groups filter.
Outputs
datalist- Service response.
Example output
{
"data": []
}List event attendees
Get event attendees list.
Inputs
- Id
idnumberRequired - Id.
- Occurrence
occurrencedateRequired - The occurrence date.
- Per page
per_pagenumber - Per page.One of:
25,50,75,100. Default:25. - Page
pagenumber - Page.Default:
1.
Outputs
datalist- Service response.
Example output
{
"data": []
}List event candidates
Get event candidate list.
Inputs
- Id
idnumberRequired - Id.
- Occurrence
occurrencedate - Occurrence.
- Per page
per_pagenumber - Per page.One of:
25,50,75,100. Default:25. - Page
pagenumber - Page.Default:
1.
Outputs
datalist- Service response.
Example output
{
"data": []
}List event guests
Get event guest list.
Inputs
- Id
idnumberRequired - Id.
- Status
statustext - Status.One of:
REQUESTING,GOING,NOT_GOING(Not going),MAYBE,NOT_RESPONDED(Not responded). - Name
nametext - Name.
- Per page
per_pagenumber - Per page.One of:
25,50,75,100. Default:25. - Page
pagenumber - Page.Default:
1.
Outputs
datalist- Service response.
Example output
{
"data": []
}List event resources
Get event resource list.
Inputs
- Id
idnumberRequired - Id.
- Per page
per_pagenumber - Per page.One of:
25,50,75,100. Default:25. - Page
pagenumber - Page.Default:
1. - Status
statustext - Status.One of:
PENDING,APPROVED. - Exclude child resources
exclude_child_resourcestrue/false - Exclude child resources.
Outputs
datalist- Service response.
Example output
{
"data": []
}List event rooms
Get event room list.
Inputs
- Id
idnumberRequired - Id.
- Per page
per_pagenumber - Per page.One of:
25,50,75,100. Default:25. - Page
pagenumber - Page.Default:
1. - Status
statustext - Status.One of:
PENDING,APPROVED.
Outputs
datalist- Service response.
Example output
{
"data": []
}List events
Get event list.
Inputs
- Per page
per_pagenumber - Per page.One of:
25,50,75,100. Default:25. - Page
pagenumber - Page.Default:
1. - Name
nametext - Name.
- Range type
range_typetext - Range type.One of:
ALL,PAST,CURRENT,FUTURE.
Outputs
datalist- Service response.
Example output
{
"data": []
}List families
Get families.
Inputs
- Last name
last_nametext - Last name.
- Email
emailtext - Email.
- Phone
phonetext - Phone.
- Per page
per_pagenumber - Per page.One of:
25,50,75,100. Default:25. - Page
pagenumber - Page.Default:
1.
Outputs
datalist- Service response.
Example output
{
"data": []
}Search events
Search events.
Inputs
- Name
nametext - Name.
- Range type
range_typetext - Range type.One of:
ALL,PAST,CURRENT,FUTURE. - Campus ids
campus_idslist - Campus ids.
- Group ids
group_idslist - Group ids.
- Group type ids
group_type_idslist - Group type ids.
- Group name
group_nametext - Group name.
- Attendance grouping ids
attendance_grouping_idslist - Attendance grouping ids.
- Department ids
department_idslist - Department ids.
- Organizer individual id
organizer_individual_idnumber - Organizer individual id.
- Event ids
event_idslist - Event ids.
- Page
pagenumber - Page.Default:
1. - Per page
per_pagenumber - Per page.One of:
25,50,75,100. Default:25.
Outputs
datalist- Service response.
Example output
{
"data": []
}Update event
Update event.
Inputs
- Id
idnumberRequired - Id.
- All day
all_daytrue/false - All day.
- Approval status id
approval_status_idnumber - Approval status id.
- Cleanup
cleanupdate and time - Cleanup.
- Confirm change
confirm_changetrue/false - To confirm if a change is being "forced" (overiding any warnding) set to true.
- Description
descriptiontext - Description.
- End
enddate and time - End.
- Group id
group_idnumber - Group id.
- Name
nametext - Name.
- Occurrence
occurrencetext - Occurrence.
- Owner id
owner_idnumber - Owner id.
- Setup
setupdate and time - Setup.
- Start
startdate and time - Start.
- Type id
type_idnumber - Require leader approval or form response to get on the guest list
- Uses resources
uses_resourcestrue/false - Uses resources.
- Phone
phonetext - Phone.
- Location name
location_nametext - Location name.
- Location street
location_streettext - Location street.
- Location city
location_citytext - Location city.
- Location state
location_statetext - Location state.
- Location zip
location_ziptext - Location zip.
- Apply changes to
apply_changes_totext - Apply changes to.One of:
ONLY_THIS_DATE(Only this date),THIS_AND_FUTURE_DATES(This and future dates),ALL_DATES(All dates). - Recurs
recurstrue/false - Recurs.
- Recur end date
recur_end_datedate and time - Recur end date.
- Recur frequency
recur_frequencytext - Daily = D | Weekly = W | Monthly by Day = MO | Monthly by Date = MPOne of:
D,W,MO,MP. - Recur interval
recur_intervalnumber - Recur interval.
- Recur freq modifier
recur_freq_modifiertext - Recur freq modifier.One of:
SU,MO,TU,WE,TH,FR,SA. - Attend max quantity
attend_max_quantitynumber - Attend max quantity.
- Checkin label quantity
checkin_label_quantitynumber - Checkin label quantity.
- Checkin label type
checkin_label_typetext - Checkin label type.One of:
NONE,NAME,SECURE. - Grouping id
grouping_idnumber - Grouping id.
- Room description
room_descriptiontext - Room description.
- Room ratio
room_rationumber - Room ratio.
- Checkin type
checkin_typetext - Checkin type.One of:
NONE,CHECKIN,PRECHECK,INSTANT. - Checkin announcement
checkin_announcementobject - Checkin announcement.
Outputs
dataobject- Service response.
Example output
{
"data": {
"actions": {
"can_edit": {
"allowed": false,
"reasons": []
},
"can_view_guest_list": {
"allowed": false,
"reasons": []
}
},
"address": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"all_day": false,
"approval_status": "example",
"approval_status_id": 1,
"attend_max_quantity": "example",
"attendance": {
"occurrence_has": false,
"occurrence_has_after": false,
"occurrence_has_before": false,
"occurrence_last_with": "2026-11-01T12:00:00Z"
},
"campus_id": 1,
"checkin": {
"announcement": {
"body": "example",
"source": "EVENT",
"source_id": 1,
"title": "example"
},
"attend_max_quantity": 1,
"checkin_label_quantity": 1,
"checkin_label_type": "NONE",
"checkin_type": "NONE",
"grouping_id": 1,
"room_description": "example",
"room_ratio": 1
},
"checkin_label_quantity": 1,
"checkin_label_type": "NONE",
"cleanup": "2026-11-01T12:00:00Z",
"creator": {
"active": false,
"addresses": {
"home": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"mailing": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"work": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
}
},
"approval_status_modifier_id": "example",
"birthday": "2026-11-01",
"campus_id": 1,
"created": "2026-11-01",
"date_child_work_start": "2026-11-01",
"date_child_work_stop": "2026-11-01",
"deceased": "2026-11-01",
"denied_status_reason": "example",
"email": "example",
"email_unsubscribed": false,
"email_unsubscribed_reason": "API_UNSUBSCRIBED",
"family_id": 1,
"family_position": "PRIMARY_CONTACT",
"first_name": "example",
"gender": "MALE",
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"is_child_work_approved": false,
"last_name": "example",
"legal_first_name": "example",
"marital_status": "MARRIED",
"membership_type_id": 1,
"middle_name": "example",
"name": "example",
"name_prefix": "example",
"name_suffix": "example",
"phone": {
"fax": "example",
"home": "example",
"mobile": "example",
"mobile_carrier_id": "example",
"pager": "example",
"work": "example"
},
"preferred_number": "HOME"
},
"date_created": "2026-11-01T12:00:00Z",
"date_modified": "2026-11-01T12:00:00Z",
"description": "example",
"end": "2026-11-01T12:00:00Z",
"estimated_attendance": "example",
"group": {
"campus_id": 1,
"coach_id": 1,
"department": {
"id": 1
},
"director_id": 1,
"group_type": {
"id": 1,
"name": "example"
},
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"inactive": false,
"interaction_type": "MEMBERS_INTERACT",
"is_system_group": false,
"main_leader": {
"actions": {
"can_view_profile": {}
},
"email": "example",
"first_name": "example",
"id": 1,
"last_name": "example",
"name": "example"
},
"membership_type": "OPEN_TO_ALL",
"name": "example",
"owner_id": 1,
"public_signup_form": {
"actions": {
"can_edit_form": {},
"can_respond_to_form": {},
"can_view_form": {}
},
"campus_id": 1,
"description": "example",
"end": "2026-11-01T12:00:00Z",
"id": 1,
"manager_count": 1,
"public": false,
"start": "2026-11-01T12:00:00Z",
"status": "ACTIVE",
"title": "example",
"url": "example"
}
},
"guest_counts": {
"going": 1,
"maybe": 1,
"not_going": 1,
"not_responded": 1,
"requesting": 1
},
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"invitation_settings": {
"allow_additional_guests": false,
"attend_max_quantity": 1,
"notify_owner_of_status_changes": false,
"show_guest_list": false
},
"modifier": {
"active": false,
"addresses": {
"home": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"mailing": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"work": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
}
},
"approval_status_modifier_id": "example",
"birthday": "2026-11-01",
"campus_id": 1,
"created": "2026-11-01",
"date_child_work_start": "2026-11-01",
"date_child_work_stop": "2026-11-01",
"deceased": "2026-11-01",
"denied_status_reason": "example",
"email": "example",
"email_unsubscribed": false,
"email_unsubscribed_reason": "API_UNSUBSCRIBED",
"family_id": 1,
"family_position": "PRIMARY_CONTACT",
"first_name": "example",
"gender": "MALE",
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"is_child_work_approved": false,
"last_name": "example",
"legal_first_name": "example",
"marital_status": "MARRIED",
"membership_type_id": 1,
"middle_name": "example",
"name": "example",
"name_prefix": "example",
"name_suffix": "example",
"phone": {
"fax": "example",
"home": "example",
"mobile": "example",
"mobile_carrier_id": "example",
"pager": "example",
"work": "example"
},
"preferred_number": "HOME"
},
"name": "example",
"next_occurrence": {
"end": "2026-11-01T12:00:00Z",
"occurrence": "example",
"start": "2026-11-01T12:00:00Z"
},
"owner": {
"active": false,
"addresses": {
"home": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"mailing": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"work": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
}
},
"approval_status_modifier_id": "example",
"birthday": "2026-11-01",
"campus_id": 1,
"created": "2026-11-01",
"date_child_work_start": "2026-11-01",
"date_child_work_stop": "2026-11-01",
"deceased": "2026-11-01",
"denied_status_reason": "example",
"email": "example",
"email_unsubscribed": false,
"email_unsubscribed_reason": "API_UNSUBSCRIBED",
"family_id": 1,
"family_position": "PRIMARY_CONTACT",
"first_name": "example",
"gender": "MALE",
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"is_child_work_approved": false,
"last_name": "example",
"legal_first_name": "example",
"marital_status": "MARRIED",
"membership_type_id": 1,
"middle_name": "example",
"name": "example",
"name_prefix": "example",
"name_suffix": "example",
"phone": {
"fax": "example",
"home": "example",
"mobile": "example",
"mobile_carrier_id": "example",
"pager": "example",
"work": "example"
},
"preferred_number": "HOME"
},
"phone": "example",
"recur_end_date": "2026-11-01T12:00:00Z",
"recurrence": {
"end": "2026-11-01",
"frequency": "example",
"frequency_modifier": "example",
"interval": 1
},
"recurs": false,
"registration": {
"closed": false,
"form_id": 1,
"url": "example"
},
"room_description": "example",
"room_ratio": "example",
"setup": "2026-11-01T12:00:00Z",
"setup_notes": "example",
"start": "2026-11-01T12:00:00Z",
"type_id": 1,
"use_campus_address": false,
"uses_resources": false
}
}Update family
Update family.
Inputs
- Id
idnumberRequired - Id.
- Last name
last_nametext - Last name.
- Campus id
campus_idnumber - Campus id.
- Address
addressobject - Address.
- Membership type id
membership_type_idnumber - Membership type id.
- Membership start date
membership_start_datedate - Membership start date.
- Message
messagetext - valid only when can_edit_checkin_message is TRUE
- Phone
phonetext - Phone.
- Active
activetrue/false - Active.
- Deceased
deceaseddate - Deceased.
- Reason left id
reason_left_idnumber - Reason left id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"actions": {},
"address": {
"carrier_route": "example",
"city": "example",
"country_iso": "example",
"latitude": "example",
"longitude": "example",
"name": "example",
"state": "example",
"street": "example",
"zip": "example"
},
"authorized_individuals": [],
"id": 1,
"images": {
"large": "example",
"medium": "example",
"thumbnail": "example"
},
"last_name": "example",
"members": [],
"message": "example",
"messages": []
}
}