Members API

by Justin Stayton, Skyler Katz | Last edited: 10/20/2017

Display mode: list

Parameters

emailencode

By default, the __emailaddress__ and __altemailaddress__ tag is obfuscated with JavaScript to prevent email harvesting. This can be disabled by including this parameter.

Example:

"emailencode:no",

find_group

Limits the members to those in one or more groups, specified by group slug. By default, groupby:group is used unless explicitly set to none.

Example:

"find_group:pastors,worship-team",

find_group_series

Limits the members to those in the groups within a series, specified by series slug. By default, groupby:group is used unless explicitly set to none.

Example:

"find_group_series:staff",

groupby

The way in which members should be grouped on return. before_group_show, after_group_show, and no_group_show tags can be used to show separation between, and information about, each group. order applies to the members within each grouping, not across all groupings.

Option Description
group Group members within the groups they belong to. For legacy reason, this is the default when find_group or find_group_series is specified. none must be explicitly set to prevent grouping.
none No grouping.

Example:

"groupby:group",

group_order

The order in which to return the groups. Only applicable in conjunction with groupby.

Option Description
find_group Order by the position listed in find_group. Only applicable with (and default for) find_group.
position Order by the group's position within the series. Only applicable with (and default for) find_group_series.
title Order by the group's title/name.

Example:

"group_order:position",

howmany

Limits the number of members returned. If used with groupby, the limit is placed on the number of members returned within each grouping. By default, 250 are returned at a time.

Example:

"howmany:25",

order

The order in which to return the members. If used with groupby, the ordering is within each grouping. lastname is used by default.

Option Description
firstname Order by the member's first name.
lastname Order by the member's last name. Default.
position Order by the member's position within the group (specified through the backend). Only applicable with find_group or find_group_series.

Example:

"order:position",

page

In conjunction with howmany, specifies which page of results to return.

Example:

"page:2",

Show

before_group_show, after_group_show

Only applicable with groupby parameter.

Tag Description
__description__ Description of group.
__email__ Email address of group.
__slug__ Slugged version of group's title/name.
__title__ Title or name of group.
show
Tag Description
__about__ Biographical information about the member.
__address__ Complete address, including street, city, state (abbreviated), country (abbreviated), and zip code.
__birthdate__ Date of birth in yyyy-mm-dd format. To change the format, include the format parameter: __birthdate format='F j, Y'__. Any PHP date() format can be used.
__cellphone__ Cell phone number.
__city__ City name of member's address.
__country__ Country name of member's address.
__countryAB__ Two letter country name abbreviation.
__emailaddress__ Email address.
__altemailaddress__ AlternateEmail address.
__facebookurl__ URL to the member's Facebook.
__facebookusername__ Facebook username.
__firstname__ First name.
__flickrurl__ URL of member's Flickr account.
__fullname__ Full name (first name and last name).
__galleryurl__ URL of member's photo gallery.
__groups__ Comma-separated list of groups the member belongs to.
__homephone__ Home phone number.
__id__ Internal ID of the member for unique identification.
__interests__ Comma separated list of interests.
__lastname__ Last name.
__latitude__ Latitude coordinate of member's address.
__longitude__ Longitude coordinate of member's address.
__photourl__ URL of member's photo. All image caching/thumbnail parameters are available.
__photothumburl__ URL of 100x100 thumbnail of member's photo.
__podcasturl__ URL of member's podcast.
__position__ Position or title.
__rssfeedurl__ URL of member's RSS feed.
__slug__ Slugged version of member's full name.
__state__ State (or region) name of member's address.
__stateAB__ Two letter state (or region) name abbreviation. Outside of the United States, this is usually a number.
__street__ Street info of member's address.
__street2__ Additional street info of member's address.
__twitterurl__ URL to the member's Twitter.
__twitterusername__ Twitter username (without leading @).
__username__ Log in username.
__websiteurl__ URL of member's website.
__workphone__ Work phone number.
__zipcode__ Zip code (or postal code) of member's address.
Any Custom Fields setup for Users will output their API tags
no_group_show

Displayed when a group has no members. Useful when combined with before_group_show and after_group_show to display information about the group with a no members message. If not specified, groups without members are not returned.

no_show

Displayed when no members are returned at all.

Display mode: profile

Parameters

emailencode

By default, the __emailaddress__ and __altemailaddress__ tag is obfuscated with JavaScript to prevent email harvesting. This can be disabled by including this parameter.

 

Example:

"emailencode:no",

find

Specifies the member to display, using either member ID, slug, or a combination of both. Since a member's slug is not guaranteed to be unique, member ID is recommended. The following example shows how both member ID and slug can be specified together.

Example:

"find:154789-michael-williams",

Show

show
Tag Description
__about__ Biographical information about the member.
__address__ Complete address, including street, city, state (abbreviated), country (abbreviated), and zip code.
__birthdate__ Date of birth in yyyy-mm-dd format. To change the format, include the format parameter: __birthdate format='F j, Y'__. Any PHP date() format can be used.
__cellphone__ Cell phone number.
__city__ City name of member's address.
__country__ Country name of member's address.
__countryAB__ Two letter country name abbreviation.
__emailaddress__ Email address.
__altemailaddress__ AlternateEmail address.
__facebookurl__ URL to the member's Facebook.
__facebookusername__ Facebook username.
__firstname__ First name.
__flickrurl__ URL of member's Flickr account.
__fullname__ Full name (first name and last name).
__galleryurl__ URL of member's photo gallery.
__groups__ Comma-separated list of groups the member belongs to.
__homephone__ Home phone number.
__id__ Internal ID of the member for unique identification.
__interests__ Comma separated list of interests.
__lastname__ Last name.
__latitude__ Latitude coordinate of member's address.
__longitude__ Longitude coordinate of member's address.
__photourl__ URL of member's photo. All image caching/thumbnail parameters are available.
__photothumburl__ URL of thumbnail of member's photo.
__podcasturl__ URL of member's podcast.
__position__ Position or title.
__rssfeedurl__ URL of member's RSS feed.
__slug__ Slugged version of member's full name.
__state__ State (or region) name of member's address.
__stateAB__ Two letter state (or region) name abbreviation. Outside of the United States, this is usually a number.
__street__ Street info of member's address.
__street2__ Additional street info of member's address.
__twitterurl__ URL to the member's Twitter.
__twitterusername__ Twitter username (without leading @).
__username__ Log in username.
__websiteurl__ URL of member's website.
__workphone__ Work phone number.
__zipcode__ Zip code (or postal code) of member's address.
Any Custom Fields setup for Users will output their API tags
no_show

Displayed when the member cannot be found.