Get person groups

get

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

Retrieve the group memberships for the given person.

Required permission: Limited Read People

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the person.

Query Params

role

int32

≥ 1

The id of a member role to filter by. Values come from /api/property_values/small_group_member_roles/values.

position

string

Comma-delimited list of serving position ids. Use -1 to include members with no position.

category

string

Return memberships whose group's category name contains the given text.

smallGroup

int32

≥ 1

The id of a group. Returns only memberships in that group.

groupName

string

Return memberships whose group's name contains the given text.

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