One Modmail thread and its messages, newest first. Without member, the caller's own thread, which is absent until they first write. With another account's member, the caller needs manage-mail. Viewer-specific and never cached; reading does not mark the thread read (see updateModmailSeen).
Parameters
Output
application/jsoncursor
string
Optional
No description available.
messages
array
Required
No description available.
thread
refcom.getorbyt.community.defs#modmailThreadView
Optional
No description available.
Errors
AuthenticationRequired
CommunityNotFound
InsufficientRole
InvalidRequest
InvalidCursor
ThreadNotFound
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "One Modmail thread and its messages, newest first. Without member, the caller's own thread, which is absent until they first write. With another account's member, the caller needs manage-mail. Viewer-specific and never cached; reading does not mark the thread read (see updateModmailSeen).",
"errors": [
{
"name": "AuthenticationRequired"
},
{
"name": "CommunityNotFound"
},
{
"name": "InsufficientRole"
},
{
"name": "InvalidRequest"
},
{
"name": "InvalidCursor"
},
{
"name": "ThreadNotFound"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"cursor": {
"type": "string"
},
"messages": {
"items": {
"ref": "com.getorbyt.community.defs#modmailMessageView",
"type": "ref"
},
"maxLength": 50,
"type": "array"
},
"thread": {
"ref": "com.getorbyt.community.defs#modmailThreadView",
"type": "ref"
}
},
"required": [
"messages"
],
"type": "object"
}
},
"parameters": {
"properties": {
"community": {
"format": "at-uri",
"type": "string"
},
"cursor": {
"description": "Continues toward older messages.",
"type": "string"
},
"limit": {
"default": 25,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"member": {
"description": "Whose thread. Absent means the caller's own.",
"format": "did",
"type": "string"
}
},
"required": [
"community"
],
"type": "params"
},
"type": "query"
}