app.atmobb.actor.getGuestbook

lexicons.atmobb.app

Documentation

The entries signed in one member's guestbook on one forum, newest first by index time. Nothing while the owner keeps it closed or is banned; entries indexed while it was closed, by signers banned or shut out by a closed gate, or within 24 hours of the same signer's previous entry never show. With includeHidden, entries hidden by staff or the owner, or from a signer the owner blocked, come back flagged instead of dropped.

main query

The entries signed in one member's guestbook on one forum, newest first by index time. Nothing while the owner keeps it closed or is banned; entries indexed while it was closed, by signers banned or shut out by a closed gate, or within 24 hours of the same signer's previous entry never show. With includeHidden, entries hidden by staff or the owner, or from a signer the owner blocked, come back flagged instead of dropped.

Parameters

cursor string Optional

No description available.

forum string did Required

A decentralized identifier (DID).

includeHidden boolean Optional

Return hidden entries, flagged. For the owner and staff.

limit integer Optional

No description available.

subject string did Required

A decentralized identifier (DID).

viewer string did Optional

Report whether the owner blocked this signer, as viewerBlocked.

Output

Encodingapplication/json
cursor string Optional

No description available.

entries array Required

No description available.

open boolean Required

Whether the guestbook takes entries now: the owner turned it on and is not banned forum-wide.

viewerBlocked boolean Optional

Only with viewer: whether the owner blocked that signer. False while the guestbook is closed.

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
A decentralized identifier (DID).
Return hidden entries, flagged. For the owner and staff.
A decentralized identifier (DID).
Report whether the owner blocked this signer, as viewerBlocked.
View raw schema 
{
  "description": "The entries signed in one member's guestbook on one forum, newest first by index time. Nothing while the owner keeps it closed or is banned; entries indexed while it was closed, by signers banned or shut out by a closed gate, or within 24 hours of the same signer's previous entry never show. With includeHidden, entries hidden by staff or the owner, or from a signer the owner blocked, come back flagged instead of dropped.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "type": "string"
        },
        "entries": {
          "items": {
            "ref": "#entry",
            "type": "ref"
          },
          "type": "array"
        },
        "open": {
          "description": "Whether the guestbook takes entries now: the owner turned it on and is not banned forum-wide.",
          "type": "boolean"
        },
        "viewerBlocked": {
          "description": "Only with viewer: whether the owner blocked that signer. False while the guestbook is closed.",
          "type": "boolean"
        }
      },
      "required": [
        "entries",
        "open"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "type": "string"
      },
      "forum": {
        "format": "did",
        "type": "string"
      },
      "includeHidden": {
        "default": false,
        "description": "Return hidden entries, flagged. For the owner and staff.",
        "type": "boolean"
      },
      "limit": {
        "default": 20,
        "maximum": 50,
        "minimum": 1,
        "type": "integer"
      },
      "subject": {
        "format": "did",
        "type": "string"
      },
      "viewer": {
        "description": "Report whether the owner blocked this signer, as viewerBlocked.",
        "format": "did",
        "type": "string"
      }
    },
    "required": [
      "forum",
      "subject"
    ],
    "type": "params"
  },
  "type": "query"
}
entry object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

cid string cid Required

For a strongRef, as a staff hide names it.

createdAt string datetime Required

The signer's own timestamp.

hidden string Optional

Only with includeHidden: why the entry is hidden. staff: a forum hide. owner: the owner hid it. blocked: the owner blocked its signer.

Known values: owner, staff, blocked
indexedAt string datetime Required

When the appview indexed the entry; ordering and every time rule use this.

text string Required

No description available.

uri string at-uri Required

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

View raw schema 
{
  "properties": {
    "author": {
      "format": "did",
      "type": "string"
    },
    "cid": {
      "description": "For a strongRef, as a staff hide names it.",
      "format": "cid",
      "type": "string"
    },
    "createdAt": {
      "description": "The signer's own timestamp.",
      "format": "datetime",
      "type": "string"
    },
    "hidden": {
      "description": "Only with includeHidden: why the entry is hidden. staff: a forum hide. owner: the owner hid it. blocked: the owner blocked its signer.",
      "knownValues": [
        "owner",
        "staff",
        "blocked"
      ],
      "type": "string"
    },
    "indexedAt": {
      "description": "When the appview indexed the entry; ordering and every time rule use this.",
      "format": "datetime",
      "type": "string"
    },
    "text": {
      "type": "string"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "author",
    "text",
    "createdAt",
    "indexedAt"
  ],
  "type": "object"
}

Lexicon Garden

@