Filtering Group Finder
Learn more about attribute filters, URL filters, and advanced filters for the Group Finder widget.
- Attribute filters: Use widget attributes before adding the widget to your webpage.
- URL filters: These are added to the end of your URL when someone views the webpage.
Attribute Filters
Use optional attributes to create different versions of the Group Finder widget for different purposes. These attributes are related to the group and are different from contact attributes. For example, you can create pages for congregations or ministries and filter for those pages.
- Congregation or Parish
- This attribute filters the results by a congregation or parish using IDs.
- Attribute: congregationid
- Valid Value: Congregation Id
- Example:
congregationid="2"
Tip: Want to display groups available to any congregation? Set the COMMON, GlobalCongregationID configuration setting, which the Group Finder sees as a church-wide congregation. - Key Word
- This filters the result using keywords. A keyword search looks for a match in the group name, group description, program name, and/or ministry name, so select keyword attributes strategically.
- Attribute: keyword
- Valid Value: This should be URL encoded.
- Standard A-Z and 0-9 characters are all valid.
- Replace spaces with a plus (+).
- Encode other characters.
- Example:
keyword="summer bbq"
- Ministry
- This filters by a ministry ID. The default is empty.
- Attribute: ministryid
- Valid Value: Ministry ID or empty.
- Example:
ministryid="7"
- Meets Online
- This filters by the Meets Online field.
- Parameter: meetsonline
- Valid Value: True or False
- Example:
meetsonline="True"
- Neighborhood (Parent Group)
- This filters by the parent group. The default is empty.
- Parameter: parentgroupid
- Valid Value: Group Id or empty for unspecified. Note: The parent group must have Available Online set to Yes for this filter to work.
- Example:
parentgroupid="16"
- Group Focus
- This filters by the general focus or subject of a group. The default is empty.
- Parameter: groupfocusid
- Valid Value: Group Focus Id or empty for unspecified.
- Example:
groupfocusid="17"
- Group Type
- This filters by a certain type of group.
- Attribute: grouptypeid
- Valid Value: one Group Type ID or empty for unspecified.
- Example:
grouptypeid="3"
- Life Stage
- This filters by life stage. The default is empty.
- Parameter: lifestageid
- Valid Value: Life Stage Id or empty for unspecified.
- Example:
lifestageid="4"
- Meeting Days
- This filters by one or more meeting day. The default is empty.
- Parameter: meetingdays
- Valid Value: 1 to 7 (1 = Sunday)
- Example:
meetingdays="1,6"
- Meeting Time
- This filters by meeting time. The default is empty.
- Parameter: meetingtimes
- Valid Value:
- Morning
- Lunchtime
- Afternoon
- Evening
- Empty for unspecified (the default)
- Example:
meetingtimes="afternoon"
<mpp-group-finder target="/group-details" congregationid="1"></mpp-group-finder>Attributes must be included before the opening widget tag is closed. Attributes may be listed in any order and should be separated by a space or other whitespace. An attribute's value should be wrapped in quotation marks.
Advanced Attribute Filters
Want to filter groups by multiple meeting days? You can do that! If the attribute is multi-select in the widget, you can include multiple comma-separated values in the attribute filter.
<mpp-group-finder target="/opportunity-details" meetingdays="2,4,6"></mpp-group-finder>
URL Filters
URL filters are applied when someone uses the Group Finder widget. Use this to direct people to a widget page with pre-selected search values. People can add or change parameters to continue to search.
You can add specific filters to the Group Finder widget's base URL to apply the search criteria you want. Pre-filtering the URL is a convenient way to contextually limit groups. In the following examples, a church has defined the path for their Group Finder widget.
Let's say the URL where your Group Finder widget is located is https://example-church.com/groups.
Now, if your small groups are accepting new members in the fall, you may provide a pre-filtered link that displays only those groups:
/groups?keyword=small
If you want to introduce several new classes that meet in the evening, you can provide a pre-filtered link for this time period:
/groups?meetingtimes=evening
Available URL filters include the following:
- Congregation/Campus
- This filters by a congregation. The default is empty.
- Parameter: congregationId
- Valid Values: A single Congregation ID or empty for unspecified.
- Example:
?congregationid=1
- Key Word
- This filters by keywords. The default is empty.
- Parameter: keyword
- Valid Values:
- Empty for unspecified
- URL encoded keywords.
- Standard A-Z and 0-9 characters are all valid.
- Replace spaces with a plus (+). Note: The is different from than the Key Word Attribute filter, which does not require the a plus.
- Other characters must be encoded.
- Example:
?keyword="new+mothers"
- Neighborhood (Parent Group)
- This filters by the parent group. The default is empty.
- Parameter: parentgroupid
- Valid Values: A Group Id or empty for unspecified.
- Example:
?parentgroupid=16
- City or Postal Code
- This filters by a city name or postal code. The default is empty.
- Parameter: citypostalcode
- Valid Values:
- Empty for unspecified.
- A postal code (ZIP code).
- URL encoded City Name
- Standard A-Z and 0-9 characters are all valid.
- Replace spaces with a plus (+).
- Other characters must be encoded.
- The easiest way to determine encoding is to search using the criteria and copy from the resulting URL.
- Example:
?citypostalcode=87659
- Group Focus
- This filters by group focus. The default is empty.
- Parameter: groupfocusid
- Valid Values: one group focus ID.
- Example:
?groupfocusid=17
- Group Type
- The filters by a certain type of group.
- Parameter: grouptypeid
- Valid Value: one group type ID.
- Example:
?grouptypeid=3
- Life Stage
- This filters by life stage. The default is empty.
- Parameter: "lifestageid"
- Valid Values: Life stage ID or empty for unspecified.
- Example:
?lifestageid=4
- Meeting Days
- This filters by one or more meeting day. The default is empty.
- Parameter: meetingdays
- Valid Values: 1 to 7 (1 = Sunday)
- Example:
?meetingdays=1,6
- Meeting Time
- This filters by meeting time. The default is empty.
- Parameter: meetingtimes
- Valid Values:
- Morning
- Lunchtime
- Afternoon
- Evening
- Empty for unspecified (the default)
- Example:
?meetingtimes=afternoon
- Meets Online
- This filters by the Meets Online field.
- Parameter: "meetsonline"
- Valid Values: True or False
- Example:
?meetsonline=true
Advanced URL Filters
Multiple Filters
A URL may contain multiple filters separated by an ampersand (&). There is no limit to the number of filters you can include. You can also combine filters to return a specific set of groups.
/groups?congregationid=5&meetingdays=4
Multiple Filter Values
A single filter may contain multiple ID values separated by a comma. Use a comma separated list of IDs to expand the set of groups returned.
/groups?meetingdays=2,3
Multiple Keywords
URLs cannot contain spaces, but you can use %20 or + instead. This is useful when combining two sequential keywords. For example, maybe "adult" or "community" would return too many groups, but "adult community" would help narrow the search.
/groups?keyword=adult+community