Search membership requests

get

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

Retrieve requests to join the given group.

Required permission: Limited Write Groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the group.

Query Params

entry

int32

≥ 1

The id of a specific request to return.

decision

string

Comma-delimited list of request decisions: pending (1), approved (2) or denied (3). Accepts the names or the numbers.

created.start

date-time

Return requests submitted on or after this date.

created.end

date-time

Return requests submitted on or before this date.

first

string

Return requests whose requester's first name contains the given text.

last

string

Return requests whose requester's last name contains the given text.

name

string

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

string

Return requests whose requester's email address contains the given text.

phone

string

Return requests whose requester's phone number contains the given digits.

gender

string

Comma-delimited list of gender ids. Values come from /api/property_values/gender/values.

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.

200OK