Filtering Online Directory

Learn more about attribute filters, URL filters, and advanced filters for the Online Directory 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.

Use optional attributes to create different versions of the widget for different purposes. For example, create pages for congregations and filter the widget for those pages. These attributes are different from contact attributes.

Note: To filter by multiple-select filter options, separate the filter options with a comma. For example, mission trip,Puerto Rico. You can only filter single-select filter options by one value. For example, congregation ID.

Note: Filter attributes pre-filter the widget results, so what displays in the widget is always limited by these filters.

Congregation

This filters the results by a single congregation.

Attribute: congregationid
Valid Value: Congregation ID
Example:
```
congregationid="2"
```

Key Word

This filters the result using a keyword. A keyword search looks for a match in the first name, nickname, last name, mobile phone, home phone, or email address, so choose your keyword attribute filter strategically.

Attribute: keyword
Valid Value: This should be URL encoded:
- Standard A-Z and 0-9 characters are all valid.
- Other characters must be encoded.
Example:
```
keyword="Anderson"
```

URL Filters

URL Filters are applied when someone uses the Online Directory 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 Online Directory widget's base URL to apply the search criteria you want. Pre-filtering the URL is a convenient way to contextually limit groups.

For example, you may want to provide a direct URL for filtering for each congregation so members can only search for members of the congregation they attend.

/online-directory?congregationid=3

Congregation

This filters the results by a single congregation ID:

Attribute: congregationid
Valid Value: A single congregation ID.
Example:
```
/online-directory?congregationid=1
```

Key Word

This filters the result by a single keyword. A keyword search looks for a match in the first name, nickname, last name, mobile phone, home phone, or email address, so choose your keyword attribute filter strategically.

Attribute: keyword
Valid Value: This should be URL encoded.
- Standard A-Z and 0-9 characters are all valid.
  
  Note: Multiple keyword filtering is not supported.
- Other characters must be encoded.
Example:
```
/online-directory?keyword=anderson
```

Household

This filters by a household ID

Attribute: householdid
Valid Value: A single Household ID.
Example:
```
/online-directory?householdid=1126
```

Advanced URL Filters

A URL can contain multiple filters separated by an ampersand (&). There is no limit to the number of filters you can include. You can also combine filters. For example, you can filter by both a congregation ID and keyword to create a filters URL to find all the Andersons at your main campus.

/online-directory?congregationid=1&keyword=anderson

Note: You can combine a congregation ID URL filter and a keyword URL filter. Or you can combine a congregation URL filter and a household ID URL filter. But if you combine a keyword filter with a household ID filter, the keyword will overrule the household ID.

What would you like to know more about?

Filtering Online Directory

Attribute Filters

URL Filters

Advanced URL Filters

Footer Section

Additional Resources

Company

We’re here for you.