com.getorbyt.community.getModmailThread

getorbyt.com

Documentation

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

main query

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

community string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

cursor string Optional

Continues toward older messages.

limit integer Optional

No description available.

member string did Optional

Whose thread. Absent means the caller's own.

Output

Encodingapplication/json
cursor string Optional

No description available.

messages array Required

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.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).
Continues toward older messages.
Whose thread. Absent means the caller's own.
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"
}

Lexicon Garden

@