List communities with various sorting options. Authentication optional; viewer state will be included if authenticated.
Parameters
category
string
Optional
Filter by category
cursor
string
Optional
Pagination cursor
language
string
language
Optional
Filter by language
limit
integer
Optional
No description available.
sort
string
Optional
Sorting method
subscribed
boolean
Optional
If true, only return communities the viewer is subscribed to. Requires authentication.
visibility
string
Optional
Filter communities by visibility level
Output
Encoding
application/jsoncommunities
array
Required
No description available.
cursor
string
Optional
No description available.
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"output": {
"schema": {
"type": "object",
"required": [
"communities"
],
"properties": {
"cursor": {
"type": "string",
"maxLength": 500
},
"communities": {
"type": "array",
"items": {
"ref": "social.coves.community.defs#communityView",
"type": "ref"
}
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"properties": {
"sort": {
"type": "string",
"default": "popular",
"maxLength": 64,
"description": "Sorting method",
"knownValues": [
"popular",
"active",
"new",
"alphabetical"
]
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 100,
"minimum": 1
},
"cursor": {
"type": "string",
"maxLength": 500,
"description": "Pagination cursor"
},
"category": {
"type": "string",
"maxLength": 50,
"description": "Filter by category"
},
"language": {
"type": "string",
"format": "language",
"description": "Filter by language"
},
"subscribed": {
"type": "boolean",
"description": "If true, only return communities the viewer is subscribed to. Requires authentication."
},
"visibility": {
"type": "string",
"maxLength": 64,
"description": "Filter communities by visibility level",
"knownValues": [
"public",
"unlisted",
"private"
]
}
}
},
"description": "List communities with various sorting options. Authentication optional; viewer state will be included if authenticated."
}