com.getorbyt.community.listMembers
A Community's members. Anyone may list active members; listing muted or banned members requires a moderator role.
Details · query
| Kind | query |
|---|---|
| Authority | community.getorbyt.com |
| Indexed |
Checks
Validunlimited-stringdefs.main.parameters.properties.cursorNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.parameters.properties.roleNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.parameters.properties.statusNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.output.schema.properties.cursorNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "A Community's members. Anyone may list active members; listing muted or banned members requires a moderator role.",
"errors": [
{
"name": "CommunityNotFound"
},
{
"name": "InsufficientRole"
},
{
"name": "InvalidCursor"
},
{
"description": "The request carried no service-auth token, or one this service could not verify for the method. Distinct from InsufficientRole: the caller's identity was never established, so no role decision was made. A client should reauthorize and retry once rather than tell the viewer they lack access.",
"name": "AuthenticationRequired"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"cursor": {
"type": "string"
},
"members": {
"items": {
"ref": "com.getorbyt.community.defs#memberView",
"type": "ref"
},
"maxLength": 50,
"type": "array"
}
},
"required": [
"members"
],
"type": "object"
}
},
"parameters": {
"properties": {
"community": {
"format": "at-uri",
"type": "string"
},
"cursor": {
"type": "string"
},
"limit": {
"default": 25,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"role": {
"knownValues": [
"owner",
"moderator",
"member"
],
"type": "string"
},
"status": {
"knownValues": [
"active",
"muted",
"banned"
],
"type": "string"
}
},
"required": [
"community"
],
"type": "params"
},
"type": "query"
}
},
"id": "com.getorbyt.community.listMembers",
"lexicon": 1
}