Lexicon Garden

com.getorbyt.community.getModmailThread

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).

Repository @getorbyt.com did:plc:2xrqztnmzlckb3xfuuukupso namespace authority
Details · query
Kindquery
Authoritycommunity.getorbyt.com
Indexed
Compare Edit in builder → Fork →
cid bafyreif4flx3ipviykwuu2rtrdbokxccmhgr3yzdip54j4xfjtvphqtuue

Checks

Valid
  • unlimited-string defs.main.parameters.properties.cursorNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.cursorNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "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"
    }
  },
  "id": "com.getorbyt.community.getModmailThread",
  "lexicon": 1
}