# app.atmobb.actor.getGuestbook

> Published by [lexicons.atmobb.app](https://lexicon.garden/identity/did:plc:dqnwiguwsbb6uwrm7a2rsff2)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.actor.getGuestbook)
- [Documentation](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.actor.getGuestbook/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.actor.getGuestbook/examples)

## Definitions

### `app.atmobb.actor.getGuestbook#entry`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `author` | `string` (did) | Yes |  |
| `cid` | `string` (cid) | Yes | For a strongRef, as a staff hide names it. |
| `createdAt` | `string` (datetime) | Yes | The signer's own timestamp. |
| `hidden` | `string` | No | Only with includeHidden: why the entry is hidden. staff: a forum hide. owner: the owner hid it. blocked: the owner blocked its signer. |
| `indexedAt` | `string` (datetime) | Yes | When the appview indexed the entry; ordering and every time rule use this. |
| `text` | `string` | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |

### `app.atmobb.actor.getGuestbook`

**Type**: `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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `forum` | `string` (did) | Yes |  |
| `includeHidden` | `boolean` | No | Return hidden entries, flagged. For the owner and staff. |
| `limit` | `integer` | No |  |
| `subject` | `string` (did) | Yes |  |
| `viewer` | `string` (did) | No | Report whether the owner blocked this signer, as viewerBlocked. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `entries` | `array` | Yes |  |
| `open` | `boolean` | Yes | Whether the guestbook takes entries now: the owner turned it on and is not banned forum-wide. |
| `viewerBlocked` | `boolean` | No | Only with viewer: whether the owner blocked that signer. False while the guestbook is closed. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "entry": {
      "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"
    },
    "main": {
      "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"
    }
  },
  "id": "app.atmobb.actor.getGuestbook",
  "lexicon": 1
}
```