Skip to content

A community's members​

GET
/communities/{key}/members

The team first (owner, leaders, volunteers), then members, newest first; with show_leaders off and a viewer below leader, one list without roles. q matches public names; total is the match count.

Parameters​

Path Parameters

key*

The community's slug or uuid.

Type
string
Required

Query Parameters

q
Type
string
role
Type
string
Valid values
"all""team""leaders""volunteers""members"
filter
Type
string
Valid values
"new_month"
limit
Type
integer
Minimum
1
Maximum
100
Default
48
offset
Type
integer
Minimum
0
Default
0

Responses​

OK

application/json
JSON
{
"data": [
],
"total": 0,
"counts": {
"all": 0,
"team": 0,
"leaders": 0,
"volunteers": 0,
"members": 0,
"new_month": 0,
"additionalProperties": "string"
},
"pagination": "string",
"additionalProperties": "string"
}

Playground​

Server
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress