Search group members

get

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

Retrieve the members of the given group. Custom fields can also be used as filters; see filtering by custom fields.

Required permission: Full Read Groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the group.

Query Params

position

string

Comma-delimited list of serving position ids. Use -1 to include members with no position. Values come from /api/groups/{id}/positions.

type

string

Comma-delimited list of member type ids (or type names). Values come from the group type's member types list: append _member_types to the group type code (e.g. /api/property_values/group_type_class_member_types/values).

campus

string

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

person

int32

The id of the person whose memberships to return.

first

string

Return members whose first name contains the given text.

last

string

Return members whose last name contains the given text.

name

string

Text matched against the member's names and aliases. When multiple words are given, every word must match.

string

Return members whose email address contains the given text.

phone

string

Return members whose phone number contains the given digits.

gender

string

Comma-delimited list of gender ids. Use -1 to include members with no gender. Values come from /api/property_values/gender/values.

age.start

double

Return members at least this old.

age.end

double

Return members at most this old.

date

date-time

Return only memberships in effect on this date.

lastAttended.start

date-time

Return members who last attended on or after this date.

lastAttended.end

date-time

Return members who last attended on or before this date.

added.start

date-time

Return members added on or after this date.

added.end

date-time

Return members added on or before this date.

dropped.start

date-time

Return members dropped on or after this date.

dropped.end

date-time

Return members dropped on or before this date.

admin

boolean

Whether the member is a group administrator.

notes

string

Return memberships whose notes contain the given text.

current

boolean

Whether the membership is current, i.e. started and not yet ended.

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:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

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