# Pushpay / Church Community Builder

> Read and manage church events and families using Pushpay ChMS API v2.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/pushpay

## Actions

### Create event

Create event.

**Inputs**

- All day (`all_day`, true/false): All day.
- Approval status id (`approval_status_id`, number): Approval status id.
- Cleanup (`cleanup`, date and time): Cleanup.
- Confirm change (`confirm_change`, true/false): To confirm if a change is being "forced" (overiding any warnding) set to true.
- Description (`description`, text): Description.
- End (`end`, date and time, required): End.
- Group id (`group_id`, number, required): Group id.
- Name (`name`, text, required): Name.
- Occurrence (`occurrence`, text): Occurrence.
- Owner id (`owner_id`, number): Owner id.
- Setup (`setup`, date and time): Setup.
- Start (`start`, date and time, required): Start.
- Type id (`type_id`, number): Require leader approval or form response to get on the guest list
- Uses resources (`uses_resources`, true/false): Uses resources.
- Phone (`phone`, text): Phone.
- Location name (`location_name`, text): Location name.
- Location street (`location_street`, text): Location street.
- Location city (`location_city`, text): Location city.
- Location state (`location_state`, text): Location state.
- Location zip (`location_zip`, text): Location zip.
- Apply changes to (`apply_changes_to`, text): Apply changes to. One of: `ONLY_THIS_DATE` (Only this date), `THIS_AND_FUTURE_DATES` (This and future dates), `ALL_DATES` (All dates).
- Recurs (`recurs`, true/false): Recurs.
- Recur end date (`recur_end_date`, date and time): Recur end date.
- Recur frequency (`recur_frequency`, text): Daily = D | Weekly = W | Monthly by Day = MO | Monthly by Date = MP. One of: `D`, `W`, `MO`, `MP`.
- Recur interval (`recur_interval`, number): Recur interval.
- Recur freq modifier (`recur_freq_modifier`, text): Recur freq modifier. One of: `SU`, `MO`, `TU`, `WE`, `TH`, `FR`, `SA`.
- Attend max quantity (`attend_max_quantity`, number): Attend max quantity.
- Checkin label quantity (`checkin_label_quantity`, number): Checkin label quantity.
- Checkin label type (`checkin_label_type`, text): Checkin label type. One of: `NONE`, `NAME`, `SECURE`.
- Grouping id (`grouping_id`, number): Grouping id.
- Room description (`room_description`, text): Room description.
- Room ratio (`room_ratio`, number): Room ratio.
- Checkin type (`checkin_type`, text): Checkin type. One of: `NONE`, `CHECKIN`, `PRECHECK`, `INSTANT`.
- Checkin announcement (`checkin_announcement`, object): Checkin announcement.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "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_id`, number): When provided, will create a new family with this individual as the primary contact (all other fields ignored)
- Last name (`last_name`, text, required): Last name.
- Campus id (`campus_id`, number): Campus id.
- Address (`address`, object): Address.
- Message (`message`, text): valid only when can_edit_checkin_message is TRUE
- Phone (`phone`, text): Phone.
- Members (`members`, list): Members.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "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 (`id`, number, required): Id.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {}
}
```

### Get church

Get current church information.

**Inputs**: None.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "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 (`id`, number, required): Id.
- Occurrence (`occurrence`, text): Occurrence.
- Attendance info (`attendance_info`, true/false): Attendance info.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "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 (`id`, number, required): Id.
- Occurrence (`occurrence`, date, required): The occurrence date.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "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 (`id`, number, required): Id.
- Start (`start`, date): Start.
- End (`end`, date): End.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### Get event occurrence

Get a specific occurrence of an event.

**Inputs**

- Event id (`event_id`, number, required): Event id.
- Occurrence (`occurrence`, date, required): Occurrence.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### Get family

Get family.

**Inputs**

- Id (`id`, number, required): Id.
- Include deceased (`include_deceased`, true/false): Include deceased. Default: `false`.
- Include inactive (`include_inactive`, true/false): Include inactive.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "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 (`location`, object): Location.
- Used by groups filter (`used_by_groups_filter`, text): Used by groups filter.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### List event attendees

Get event attendees list.

**Inputs**

- Id (`id`, number, required): Id.
- Occurrence (`occurrence`, date, required): The occurrence date.
- Per page (`per_page`, number): Per page. One of: `25`, `50`, `75`, `100`. Default: `25`.
- Page (`page`, number): Page. Default: `1`.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### List event candidates

Get event candidate list.

**Inputs**

- Id (`id`, number, required): Id.
- Occurrence (`occurrence`, date): Occurrence.
- Per page (`per_page`, number): Per page. One of: `25`, `50`, `75`, `100`. Default: `25`.
- Page (`page`, number): Page. Default: `1`.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### List event guests

Get event guest list.

**Inputs**

- Id (`id`, number, required): Id.
- Status (`status`, text): Status. One of: `REQUESTING`, `GOING`, `NOT_GOING` (Not going), `MAYBE`, `NOT_RESPONDED` (Not responded).
- Name (`name`, text): Name.
- Per page (`per_page`, number): Per page. One of: `25`, `50`, `75`, `100`. Default: `25`.
- Page (`page`, number): Page. Default: `1`.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### List event resources

Get event resource list.

**Inputs**

- Id (`id`, number, required): Id.
- Per page (`per_page`, number): Per page. One of: `25`, `50`, `75`, `100`. Default: `25`.
- Page (`page`, number): Page. Default: `1`.
- Status (`status`, text): Status. One of: `PENDING`, `APPROVED`.
- Exclude child resources (`exclude_child_resources`, true/false): Exclude child resources.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### List event rooms

Get event room list.

**Inputs**

- Id (`id`, number, required): Id.
- Per page (`per_page`, number): Per page. One of: `25`, `50`, `75`, `100`. Default: `25`.
- Page (`page`, number): Page. Default: `1`.
- Status (`status`, text): Status. One of: `PENDING`, `APPROVED`.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### List events

Get event list.

**Inputs**

- Per page (`per_page`, number): Per page. One of: `25`, `50`, `75`, `100`. Default: `25`.
- Page (`page`, number): Page. Default: `1`.
- Name (`name`, text): Name.
- Range type (`range_type`, text): Range type. One of: `ALL`, `PAST`, `CURRENT`, `FUTURE`.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### List families

Get families.

**Inputs**

- Last name (`last_name`, text): Last name.
- Email (`email`, text): Email.
- Phone (`phone`, text): Phone.
- Per page (`per_page`, number): Per page. One of: `25`, `50`, `75`, `100`. Default: `25`.
- Page (`page`, number): Page. Default: `1`.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### Search events

Search events.

**Inputs**

- Name (`name`, text): Name.
- Range type (`range_type`, text): Range type. One of: `ALL`, `PAST`, `CURRENT`, `FUTURE`.
- Campus ids (`campus_ids`, list): Campus ids.
- Group ids (`group_ids`, list): Group ids.
- Group type ids (`group_type_ids`, list): Group type ids.
- Group name (`group_name`, text): Group name.
- Attendance grouping ids (`attendance_grouping_ids`, list): Attendance grouping ids.
- Department ids (`department_ids`, list): Department ids.
- Organizer individual id (`organizer_individual_id`, number): Organizer individual id.
- Event ids (`event_ids`, list): Event ids.
- Page (`page`, number): Page. Default: `1`.
- Per page (`per_page`, number): Per page. One of: `25`, `50`, `75`, `100`. Default: `25`.

**Outputs**

- `data` (list): Service response.

**Example output**

```json
{
  "data": []
}
```

### Update event

Update event.

**Inputs**

- Id (`id`, number, required): Id.
- All day (`all_day`, true/false): All day.
- Approval status id (`approval_status_id`, number): Approval status id.
- Cleanup (`cleanup`, date and time): Cleanup.
- Confirm change (`confirm_change`, true/false): To confirm if a change is being "forced" (overiding any warnding) set to true.
- Description (`description`, text): Description.
- End (`end`, date and time): End.
- Group id (`group_id`, number): Group id.
- Name (`name`, text): Name.
- Occurrence (`occurrence`, text): Occurrence.
- Owner id (`owner_id`, number): Owner id.
- Setup (`setup`, date and time): Setup.
- Start (`start`, date and time): Start.
- Type id (`type_id`, number): Require leader approval or form response to get on the guest list
- Uses resources (`uses_resources`, true/false): Uses resources.
- Phone (`phone`, text): Phone.
- Location name (`location_name`, text): Location name.
- Location street (`location_street`, text): Location street.
- Location city (`location_city`, text): Location city.
- Location state (`location_state`, text): Location state.
- Location zip (`location_zip`, text): Location zip.
- Apply changes to (`apply_changes_to`, text): Apply changes to. One of: `ONLY_THIS_DATE` (Only this date), `THIS_AND_FUTURE_DATES` (This and future dates), `ALL_DATES` (All dates).
- Recurs (`recurs`, true/false): Recurs.
- Recur end date (`recur_end_date`, date and time): Recur end date.
- Recur frequency (`recur_frequency`, text): Daily = D | Weekly = W | Monthly by Day = MO | Monthly by Date = MP. One of: `D`, `W`, `MO`, `MP`.
- Recur interval (`recur_interval`, number): Recur interval.
- Recur freq modifier (`recur_freq_modifier`, text): Recur freq modifier. One of: `SU`, `MO`, `TU`, `WE`, `TH`, `FR`, `SA`.
- Attend max quantity (`attend_max_quantity`, number): Attend max quantity.
- Checkin label quantity (`checkin_label_quantity`, number): Checkin label quantity.
- Checkin label type (`checkin_label_type`, text): Checkin label type. One of: `NONE`, `NAME`, `SECURE`.
- Grouping id (`grouping_id`, number): Grouping id.
- Room description (`room_description`, text): Room description.
- Room ratio (`room_ratio`, number): Room ratio.
- Checkin type (`checkin_type`, text): Checkin type. One of: `NONE`, `CHECKIN`, `PRECHECK`, `INSTANT`.
- Checkin announcement (`checkin_announcement`, object): Checkin announcement.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "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 (`id`, number, required): Id.
- Last name (`last_name`, text): Last name.
- Campus id (`campus_id`, number): Campus id.
- Address (`address`, object): Address.
- Membership type id (`membership_type_id`, number): Membership type id.
- Membership start date (`membership_start_date`, date): Membership start date.
- Message (`message`, text): valid only when can_edit_checkin_message is TRUE
- Phone (`phone`, text): Phone.
- Active (`active`, true/false): Active.
- Deceased (`deceased`, date): Deceased.
- Reason left id (`reason_left_id`, number): Reason left id.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "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": []
  }
}
```
