app.atmobb.forum.getStamps

lexicons.atmobb.app

Documentation

A forum's stamps: the admin-defined stamp records plus the generated network set. With actor, also that member's tray (every stamp they hold on this forum), the ids they currently wear, in order, and the topics they pinned to their profile page.

main query

A forum's stamps: the admin-defined stamp records plus the generated network set. With actor, also that member's tray (every stamp they hold on this forum), the ids they currently wear, in order, and the topics they pinned to their profile page.

Parameters

actor string did Optional

A member whose tray and worn list to include.

forum string did Required

A decentralized identifier (DID).

Output

Encodingapplication/json
network array Required

The fixed network stamps every forum on this appview offers (first light, early days). Board and arrival defaults are per member and appear in the tray.

pinned array Optional

At-uris the actor pinned to their profile page on this forum, from their newest membership record, in order. Unverified: the app checks each is the actor's own readable topic. Present only when actor is given.

stamps array Required

Stamps the forum defined, as app.atmobb.forum.stamp records.

tray array Optional

Every stamp the actor holds on this forum. Present only when actor is given.

worn array Optional

Ids from the tray the actor wears, in order. Present only when actor is given.

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 member whose tray and worn list to include.
A decentralized identifier (DID).
View raw schema 
{
  "description": "A forum's stamps: the admin-defined stamp records plus the generated network set. With actor, also that member's tray (every stamp they hold on this forum), the ids they currently wear, in order, and the topics they pinned to their profile page.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "network": {
          "description": "The fixed network stamps every forum on this appview offers (first light, early days). Board and arrival defaults are per member and appear in the tray.",
          "items": {
            "ref": "#generatedStamp",
            "type": "ref"
          },
          "type": "array"
        },
        "pinned": {
          "description": "At-uris the actor pinned to their profile page on this forum, from their newest membership record, in order. Unverified: the app checks each is the actor's own readable topic. Present only when actor is given.",
          "items": {
            "format": "at-uri",
            "type": "string"
          },
          "maxLength": 4,
          "type": "array"
        },
        "stamps": {
          "description": "Stamps the forum defined, as app.atmobb.forum.stamp records.",
          "items": {
            "ref": "#stampView",
            "type": "ref"
          },
          "type": "array"
        },
        "tray": {
          "description": "Every stamp the actor holds on this forum. Present only when actor is given.",
          "items": {
            "ref": "#trayEntry",
            "type": "ref"
          },
          "type": "array"
        },
        "worn": {
          "description": "Ids from the tray the actor wears, in order. Present only when actor is given.",
          "items": {
            "maxLength": 300,
            "type": "string"
          },
          "maxLength": 6,
          "type": "array"
        }
      },
      "required": [
        "stamps",
        "network"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "actor": {
        "description": "A member whose tray and worn list to include.",
        "format": "did",
        "type": "string"
      },
      "forum": {
        "format": "did",
        "type": "string"
      }
    },
    "required": [
      "forum"
    ],
    "type": "params"
  },
  "type": "query"
}
generatedStamp object

A stamp the network generates rather than an admin defining. Its id is fixed: atmobb:board:<board at-uri>, atmobb:arrival, atmobb:first-light, or atmobb:early-days.

Properties

board string at-uri Optional

For a board stamp: the board it marks.

id string Required

No description available.

maxLength: 300 bytes
name string Required

No description available.

maxLength: 240 bytesmaxGraphemes: 24 graphemes
sponsor string did Optional

For an arrival stamp: who brought the member in.

via string Optional

For an arrival stamp: how the member was accepted.

maxLength: 32 bytes
Known values: invite, application, founding
View raw schema 
{
  "description": "A stamp the network generates rather than an admin defining. Its id is fixed: atmobb:board:<board at-uri>, atmobb:arrival, atmobb:first-light, or atmobb:early-days.",
  "properties": {
    "board": {
      "description": "For a board stamp: the board it marks.",
      "format": "at-uri",
      "type": "string"
    },
    "id": {
      "maxLength": 300,
      "type": "string"
    },
    "look": {
      "ref": "app.atmobb.forum.stamp#look",
      "type": "ref"
    },
    "name": {
      "maxGraphemes": 24,
      "maxLength": 240,
      "type": "string"
    },
    "sponsor": {
      "description": "For an arrival stamp: who brought the member in.",
      "format": "did",
      "type": "string"
    },
    "trigger": {
      "ref": "app.atmobb.forum.stamp#trigger",
      "type": "ref"
    },
    "via": {
      "description": "For an arrival stamp: how the member was accepted.",
      "knownValues": [
        "invite",
        "application",
        "founding"
      ],
      "maxLength": 32,
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "look"
  ],
  "type": "object"
}
stampView object

An admin-defined stamp. uri and cid let a by-hand award build its strongRef.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

name string Required

No description available.

maxLength: 240 bytesmaxGraphemes: 24 graphemes
uri string at-uri Required

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

View raw schema 
{
  "description": "An admin-defined stamp. uri and cid let a by-hand award build its strongRef.",
  "properties": {
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "look": {
      "ref": "app.atmobb.forum.stamp#look",
      "type": "ref"
    },
    "name": {
      "maxGraphemes": 24,
      "maxLength": 240,
      "type": "string"
    },
    "trigger": {
      "ref": "app.atmobb.forum.stamp#trigger",
      "type": "ref"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "name",
    "look",
    "trigger",
    "createdAt"
  ],
  "type": "object"
}
trayEntry object

One stamp a member holds. id is the stamp record's at-uri for an admin stamp or the fixed id of a generated one. uri, cid, and look are present for admin stamps and look for network stamps; a board default carries the board and its color so the app can draw it, and an arrival default carries via and sponsor.

Properties

board string at-uri Optional

For a board stamp: the board it marks.

boardColor string Optional

For a board stamp: the board's six-digit hex color, when it has one.

maxLength: 7 bytes
cid string cid Optional

A content identifier (CID) referencing immutable data.

id string Required

No description available.

maxLength: 300 bytes
name string Required

No description available.

maxLength: 240 bytesmaxGraphemes: 24 graphemes
source string Required

How the member came to hold it: an admin-defined trigger, a default every member gets, the network set, or a by-hand award.

maxLength: 32 bytes
Known values: admin, default, network, byHand
sponsor string did Optional

For an arrival stamp: who brought the member in.

triggerBoardName string Optional

The board name for an earned firstPostInBoard trigger.

uri string at-uri Optional

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

via string Optional

For an arrival stamp: how the member was accepted.

maxLength: 32 bytes
Known values: invite, application, founding
View raw schema 
{
  "description": "One stamp a member holds. id is the stamp record's at-uri for an admin stamp or the fixed id of a generated one. uri, cid, and look are present for admin stamps and look for network stamps; a board default carries the board and its color so the app can draw it, and an arrival default carries via and sponsor.",
  "properties": {
    "board": {
      "description": "For a board stamp: the board it marks.",
      "format": "at-uri",
      "type": "string"
    },
    "boardColor": {
      "description": "For a board stamp: the board's six-digit hex color, when it has one.",
      "maxLength": 7,
      "type": "string"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "id": {
      "maxLength": 300,
      "type": "string"
    },
    "look": {
      "ref": "app.atmobb.forum.stamp#look",
      "type": "ref"
    },
    "name": {
      "maxGraphemes": 24,
      "maxLength": 240,
      "type": "string"
    },
    "source": {
      "description": "How the member came to hold it: an admin-defined trigger, a default every member gets, the network set, or a by-hand award.",
      "knownValues": [
        "admin",
        "default",
        "network",
        "byHand"
      ],
      "maxLength": 32,
      "type": "string"
    },
    "sponsor": {
      "description": "For an arrival stamp: who brought the member in.",
      "format": "did",
      "type": "string"
    },
    "trigger": {
      "ref": "app.atmobb.forum.stamp#trigger",
      "type": "ref"
    },
    "triggerBoardName": {
      "description": "The board name for an earned firstPostInBoard trigger.",
      "type": "string"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "via": {
      "description": "For an arrival stamp: how the member was accepted.",
      "knownValues": [
        "invite",
        "application",
        "founding"
      ],
      "maxLength": 32,
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "source"
  ],
  "type": "object"
}

Lexicon Garden

@