Lists pending requests to join a community that requires approval.
Parameters
community
string
did
Required
The community to list applications for.
cursor
string
Optional
Pagination cursor from a previous response.
includeDismissed
boolean
Optional
Whether to include applications a moderator has hidden from the active queue.
limit
integer
Optional
Maximum number of applications to return.
Output
Encoding
application/jsonapplications
array
Required
Applications matching the request.
cursor
string
Optional
Pagination cursor for the next page, if more applications exist.
Errors
AuthRequired
The request is missing, malformed, or unverifiable service auth. Forbidden
The caller lacks the approval.manage permission. CommunityNotFound
No community exists at the given DID. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Lists pending requests to join a community that requires approval.",
"errors": [
{
"description": "The request is missing, malformed, or unverifiable service auth.",
"name": "AuthRequired"
},
{
"description": "The caller lacks the approval.manage permission.",
"name": "Forbidden"
},
{
"description": "No community exists at the given DID.",
"name": "CommunityNotFound"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"applications": {
"description": "Applications matching the request.",
"items": {
"description": "A pending application.",
"ref": "social.colibri.beta.community.defs#applicationView",
"type": "ref"
},
"type": "array"
},
"cursor": {
"description": "Pagination cursor for the next page, if more applications exist.",
"type": "string"
}
},
"required": [
"applications"
],
"type": "object"
}
},
"parameters": {
"properties": {
"community": {
"description": "The community to list applications for.",
"format": "did",
"type": "string"
},
"cursor": {
"description": "Pagination cursor from a previous response.",
"type": "string"
},
"includeDismissed": {
"default": false,
"description": "Whether to include applications a moderator has hidden from the active queue.",
"type": "boolean"
},
"limit": {
"default": 50,
"description": "Maximum number of applications to return.",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"required": [
"community"
],
"type": "params"
},
"type": "query"
}