Lists a community's threads, most recently active first. Threads the requesting user may not read are absent rather than refused.
Parameters
channel
string
space-ref
Optional
Restrict the list to threads in one channel. Absent lists every channel's threads, which is what the community sidebar needs.
community
string
did
Required
The community to list threads in.
cursor
string
Optional
Pagination cursor from a previous call.
filter
string
Optional
Which threads to list.
limit
integer
Optional
Maximum number of threads to return.
Output
application/jsoncursor
string
Optional
Pagination cursor for the next page.
threads
array
Required
The threads.
Errors
AuthRequired
The request has no valid service auth. Forbidden
The requesting user is not a member of this community. CommunityNotFound
No community matches the given DID. ChannelNotFound
No channel matches the given space reference. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Lists a community's threads, most recently active first. Threads the requesting user may not read are absent rather than refused.",
"errors": [
{
"description": "The request has no valid service auth.",
"name": "AuthRequired"
},
{
"description": "The requesting user is not a member of this community.",
"name": "Forbidden"
},
{
"description": "No community matches the given DID.",
"name": "CommunityNotFound"
},
{
"description": "No channel matches the given space reference.",
"name": "ChannelNotFound"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"cursor": {
"description": "Pagination cursor for the next page.",
"type": "string"
},
"threads": {
"description": "The threads.",
"items": {
"description": "A thread.",
"ref": "social.colibri.beta.thread.defs#threadView",
"type": "ref"
},
"type": "array"
}
},
"required": [
"threads"
],
"type": "object"
}
},
"parameters": {
"properties": {
"channel": {
"description": "Restrict the list to threads in one channel. Absent lists every channel's threads, which is what the community sidebar needs.",
"format": "space-ref",
"type": "string"
},
"community": {
"description": "The community to list threads in.",
"format": "did",
"type": "string"
},
"cursor": {
"description": "Pagination cursor from a previous call.",
"type": "string"
},
"filter": {
"default": "all",
"description": "Which threads to list.",
"knownValues": [
"all",
"unread",
"following"
],
"type": "string"
},
"limit": {
"default": 50,
"description": "Maximum number of threads to return.",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"required": [
"community"
],
"type": "params"
},
"type": "query"
}