Search groups

get

https://{tenant}.onechurchsoftware.com/api/groups

Retrieve a list of groups matching the given filters. Custom fields can also be used as filters; see filtering by custom fields.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return groups whose name contains the given text.

type

string

Comma-delimited list of group type ids. Values come from /api/property_values/group_types/values.

listed

boolean

Whether to return listed or unlisted groups.

mailchimp

boolean

Whether the group is connected to a Mailchimp list.

leader

int32

≥ 1

The id of a person. Returns groups the person leads.

leaderName

string

Return groups led by someone whose name contains the given text.

campus

string

Comma-delimited list of campus ids. Use -1 to include groups without a campus. Values come from /api/locations.

active

boolean

Whether to return active or inactive groups.

language

string

Comma-delimited list of language ids. Use -1 to include groups without a language. Values come from /api/property_values/languages/values.

category

string

Comma-delimited list of category ids. Use -1 to include groups without a category. Values come from the group type's category list: append _categories to the group type code (e.g. /api/property_values/group_type_class_categories/values).

weekday

string

Comma-delimited list of weekday names. Returns groups that meet on any of the given weekdays.

address.street

string

Return groups that meet at a street address containing the given text.

address.city

string

Return groups that meet at an address whose city contains the given text.

address.state

string

Return groups that meet in the given state. Use the full state name, not an abbreviation.

address.postalCode

string

Return groups that meet at an address with the given postal code.

address.country

string

Return groups that meet in the given country. Use the full country name, not an abbreviation.

childcare

boolean

Whether childcare is provided in the group.

parent

int32

The id of a parent group. Returns its sub-groups. Use -1 to return only groups without a parent.

parentName

string

Return groups whose parent group's name contains the given text.

membership

string

Comma-delimited list of membership type ids: 1 = auto enroll, 2 = approval required.

public

boolean

Whether the group is published to the public group finder.

featured

boolean

Whether the group is featured.

registration

boolean

Whether registration is required to join the group.

form

int32

The id of a sign-up form. Returns groups using that form; use -1 for groups with no sign-up form. Values come from /api/forms.

members.start

double

Return groups with at least this many members.

members.end

double

Return groups with at most this many members.

createdBy

string

Return groups created by a user whose name contains the given text.

filter

string

Full-text search text. Matching groups are returned ranked by relevance.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK