Groups API

by Skyler Katz | Last edited: 6/9/2020

Display mode: list

Parameters

find_series

Limits the groups to those in a series, specified by series slug. before_series_show and after_series_show can be used to show information about the series.

Example:

"find_series:staff",

howmany

Limits the number of groups returned. By default, 250 are returned at a time.

Example:

"howmany:25",

order

The order in which to return the groups. title is used by default.

Option Description
position Order by the group's position within the series (specified through the backend). Only applicable with find_series.
title Order by the group's title. Default.

Example:

"order:position",

page

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

Example:

"page:2",

Show

before_series_show, after_series_show

Only applicable in conjunction with find_series.

Tag Description
__imageurl__ URL of the series' image. All image caching/thumbnail parameters are available.
__slug__ Slugged version of the series' title.
__title__ Title of the series.
__text__ Description of the series.
show
Tag Description
__description__ Description of the group.
__email__ Email address of the group.
__slug__ Slugged version of the group's title.
__title__ Title or name of the group.
__privacy__ Displays public or private depending on the groups privacy setting in the CMS
Any Custom Fields setup for Groups will output their API tags

Display mode: detail

Parameters

find

The slugged title of the group to return.

Example:

"find:worship-team",

Show

Tag Description
__description__ Description of the group.
__email__ Email address of the group.
__slug__ Slugged version of the group's title.
__title__ Title or name of the group.
__privacy__ Displays public or private depending on the groups privacy setting in the CMS
Any Custom Fields setup for Groups will output their API tags